First-run setup#
On a brand-new install, Reportworq boots into a one-time, full-screen setup wizard instead of the sign-in screen. The wizard gets the server to a usable state: it chooses where the Repository stores its data, applies the license, and creates the first administrator account. It runs once. After you finish it, all further administration happens in Settings, and you can reopen the wizard from there if you need to reconfigure the Repository later.
Before you begin#
- A completed install with the Bootstrap Service running, see Install Reportworq.
- Your license key.
- The credentials you want for the first administrator account.
Open the wizard#
- On the server, browse to
https://localhost:8600. On a fresh install with an empty Repository, this opens the setup wizard rather than the sign-in screen. (A fresh Windows install serves over HTTPS by default, see System requirements.)
Work through the steps#
The wizard advances through five named steps:
- Welcome. The intro step ("Get up and running in a few steps!"). Continue.
- Repository. Choose where Reportworq stores its data, and how this install obtains its Repository. Pick one of four options (see below).
- License. Enter your license key to apply the license. For a server without connectivity to the licensing service, use the manual activation path described in Install Reportworq.
- Users. Create the first Reportworq administrator account. This is the identity you will sign in with after setup.
- Finish. Setup completes and reloads into the normal app, which presents the sign-in screen.
Repository options#
The Repository step offers four choices:
- Create a new repository. Start fresh at an empty or unused path. This is the usual choice for a new install, and it leads on through the License and Users steps.
- Import a Reportworq v5 repository. Create a new v6 repository from a copy of an existing v5 repository. Use this to upgrade a v5 instance; the v5 repository is copied and left unchanged.
- Connect to an existing repository. Point this install at a repository that already contains Reportworq v6 data. Do not point it at a v5 repository. To bring a v5 instance forward, use Import a Reportworq v5 repository above, which creates a new v6 repository from a copy and leaves the v5 original untouched.
- Add a load balancer to an existing web app. Run this install as an additional execution node that shares the primary web app's repository, see Deployment topology.
The three existing-repository choices (import, connect, and load balancer) apply the choice and restart the service, then present a short sign-in path. Only Create a new repository continues on to the License and Users steps in the same session.
When you complete a new-Repository install, Reportworq seeds a workspace named Default so you land in a usable workspace after signing in.
The security defaults, and when to tighten them#
A fresh install deliberately starts open, so that the person who just finished the wizard can actually use it. Two defaults do that, and both are worth understanding on day one:
- The Administrator entitlement is seeded with All Users, so every enabled account is an administrator.
- The Default workspace's member entitlement and its root folder ACL are seeded with All Users, so every account can reach everything in that workspace.
This is a bootstrap posture, not a recommendation. If more than one person will use this environment, tighten it before you add accounts:
- Remove All Users from the Administrator entitlement and name the specific accounts or groups that should administer the environment. This matters most under single sign-on, where accounts are provisioned automatically at first login: leave it as seeded and everyone who signs in becomes an administrator.
- Decide what the workspace root should be. Leaving All Users on the workspace root folder is perfectly reasonable if you are not using folder-level security and everyone in the workspace is meant to see everything in it. If you do intend to secure by folder, replace it with the groups that should have access, because a permissive root undercuts the folder ACLs beneath it.
See Accounts, groups, and entitlements for the entitlement catalog and how membership resolves.
After the wizard#
- Sign in with the administrator account you just created.
- You land in the Default workspace, ready to configure connections, providers, and distributors.
Notes and limits#
- The wizard runs only on an empty Repository. A server whose Repository is already configured, or that already has accounts, does not show the full wizard again on its own.
- If a new-Repository install needs a restart to bind the Repository, the wizard resumes at the License step rather than starting over.
- A node pointed at an existing Repository (for example a load-balancer node) takes a shorter "Restart and login" path instead of the full new-Repository finish, see Deployment topology.
- You can reopen the wizard later to reconfigure. To change the Repository path, connect or import a repository, or convert this install into a load-balancer node after setup, go to Settings > Configuration > Web Server and select Reconfigure. Manage accounts under Security, see Accounts, groups, and entitlements.
Going deeper. For the license model and entitlements applied in the License step, see Licensing and entitlements.
Feedback on this page
Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.
Email feedback on this pageOr write to support@reportworq.com directly.