Look after a server

Wiki / Station

The Server view is the dashboard for the server you are working with: an instance on your computer, or a saved connection.

Status

The first section shows whether the server is running, for how long and with how many connections, beside Start server or Stop server. Below it are the instance's database, Bolt address, user and data folder, with Copy URL, Copy password and Show in folder.

If the Bolt port is taken by another program when the instance starts, Station offers the next free port: Use port N and start.

For a saved connection, the section shows its address, whether it uses TLS, the server's version, your user and the time a round trip takes. The Databases section lists each database with its status and engine mode, and creates and drops databases.

Backup and restore

Each row says what it does, and when its buttons are unavailable it says why in the row: Start the server first, Stop the server first, or that another backup or import is running.

  • Database snapshot: Back up now writes a .gdb file of the database while it runs; clients keep working. Restore… replaces the database with a snapshot, after you type its name to confirm.
  • Import: Neo4j dump… loads a Neo4j 4.x or 5.x .dump into an empty database. Run script… runs a Cypher file (.cypher, .cql or .txt) statement by statement.
  • Instance archive: with the server stopped, Archive… saves the whole instance, users included, as a .tar.gz. Restore archive… brings one back.

Backups go to backups in Station's folder unless you choose another place. Progress and the outcome of each job appear under the section, and in the corner when it finishes.

For a saved connection, the Backups section streams snapshots over Bolt, where the server allows it. See Back up or restore a database for how the server makes them.

Activity

While the server runs, Activity lists the queries running now, with the user, the database and how long each has run. ■ stops one. The list refreshes every few seconds.

Users and roles

Users & roles lists the accounts in the system database and their roles.

  • + New user asks for a name, offers a generated password with Copy, and lets you choose roles. Tick Ask them to change it when they first sign in to make the password a temporary one.
  • Each user has Password…, Suspend or Reactivate, and delete. Station asks before suspending or deleting an account.
  • A user's roles show as chips on their row: + Role gives another, and clicking a chip takes that role away. Add role creates a new role.

Managing users needs the admin role on that server.

Servers and databases · Authentication · Native Neo4j dump imports

Planning a deployment? Review compatibility and licence setup for your instance.