Servers App
Getting Started
Getting Started with Servers App
This guide walks you through the initial setup and configuration of the Servers App, including adding your first server and authenticating for data synchronization.
Prerequisites
Before using the Servers App, ensure you have:
- FlowState application installed (Electron desktop or web version)
- Access to at least one RxDB server (development or production)
- An email address for authentication (if server sync is required)
Accessing the App
- Open the FlowState application
- Navigate to the app launcher (click the grid icon or press
Cmd/Ctrl+K) - Select "Servers" from the settings category
The Servers App opens at the base path /apps/servers.
Initial Setup
Step 1: View the Server List
When you first open the Servers App, you'll see the main server management page. If no servers are configured, an empty state will guide you to add your first server.
Step 2: Add Your First Server
- Click the Add Server button (or press
Cmd/Ctrl+N) - The server configuration dialog opens with default development settings pre-filled:
| Field | Default Value | Description |
|---|---|---|
| Server Name | flowstate-dev | Display name for the server |
| URL | https://localhost:7443 | RxDB server endpoint |
| Database Name | flowstate-dev | Database to connect to |
| Domain ID | flowstate-dev | Multi-tenant identifier |
- Customize these values for your server environment
- (Optional) Click Test Connection to verify connectivity
- Click Save to create the server configuration
Step 3: Set the Active Server
After adding a server, you need to set it as active to enable data replication:
- Find your server in the server list
- Click the Set Active button in the Actions column
- A star icon appears next to the server name, indicating it's active
- The status badge changes to "Active"
Step 4: Authenticate (Optional)
If your server requires authentication for data sync:
- Click the Login button in the Auth column
- You'll be redirected to the login page for that server
- Enter your email address and click Send Code
- Check your email for the verification code
- Enter the code to complete authentication
- Upon success, you're redirected back to the server list
The server now shows "Authenticated" status in the Auth column.
Understanding Server Status
The Servers App displays several status indicators:
| Indicator | Meaning |
|---|---|
| Star icon | This is the active server |
| "Active" badge | Server is used for replication |
| "Authenticated" badge | You're logged in to this server |
| "Not Authenticated" badge | Server requires login |
Status Bar
At the bottom of the app, the status bar shows:
- Mode: Current replication mode (local/server)
- Server Count: Total number of configured servers
- Organization: Current organization context
Next Steps
Once you've completed the initial setup:
- Explore Features & Capabilities for detailed feature documentation
- Learn the Adding a Server workflow for advanced configuration
- Check the FAQ for answers to common questions
- Review Troubleshooting if you encounter issues