# Run Explorer

[Wiki](../README.md) / [Explorer](README.md)

Explorer is published on Docker Hub as `ianknowles/galactus-db-explorer`, for Linux AMD64
and ARM64. Its version follows the database: Explorer 2.2.4 ships with Galactus DB 2.2.4,
and `latest` is the newest release. The [Docker Compose example](../operations/docker.md)
starts the database and Explorer together.

## Sign in

Open <http://127.0.0.1:7474>. In the Compose stack, use the prefilled endpoint
`bolt://db:7687`, username `gdb` and the database password you set in `.env`. For any
other server, enter an address the Explorer container can reach, such as
`bolt+s://db.example.com:7687` for a server with TLS.

Your credentials live in the Explorer process for the length of the session and are
discarded when you log out, switch instance, restart Explorer or the session expires.
Explorer uses database accounts, which are separate from your galactusdb.com account.

## Saved connections

The sign-in page keeps cards for the instances you use, with a display name, endpoint,
username and database. **Save password on this device** is off by default. When you turn
it on, the password is stored unencrypted in that browser's local storage until you
update or remove the connection, so use it on a device and browser profile you trust.

## Settings

| Environment | Container setting | Purpose |
|---|---|---|
| `GDB_EXPLORER_LISTEN` | `0.0.0.0:7474` | HTTP listener inside the container |
| `GDB_EXPLORER_DEFAULT_ENDPOINT` | `bolt://db:7687` in the example | Prefilled Bolt endpoint |
| `GDB_EXPLORER_DEFAULT_USER` | `gdb` | Prefilled username |
| `GDB_EXPLORER_ALLOWED_HOSTS` | unset (any endpoint) | Instances a publicly hosted Explorer may reach; see below |
| `GDB_EXPLORER_CA_FILE` | unset | PEM certificate authorities to trust for `bolt+s://` instead of the public roots |

The first three prefill the sign-in form; they do not create database accounts. See
[authentication](../operations/authentication.md). `bolt+ssc://` encrypts without checking
the certificate, for a server with a self-signed one.

## Link to an instance

`/login?endpoint=bolt%2Bs://HOST:7687&user=NAME&name=LABEL` opens the sign-in form with
those fields filled in (`connection` is accepted for `endpoint`). The password is never
taken from a link. If the browser is already connected to a different instance, the form
is shown instead of the workbench.

## Host Explorer for other people

`GDB_EXPLORER_ALLOWED_HOSTS` is a comma-separated list of `host:port` rules; `*.` allows
subdomains, for example `*.db.example.com:7687`. When it is set, Explorer only connects
with verified TLS (`bolt+s://`) to a matching host and port, and only when every address
the name resolves to is a public internet address. It cannot then reach the machine it
runs on, its private network or cloud metadata services. An invalid value stops Explorer
at startup. Put Explorer behind an HTTPS reverse proxy when it is reachable over a
network.

## Licences

Explorer needs no licence key. A fresh database runs the free Community edition; run
`CALL gdb.license()` to see its edition, instance ID, cores and status. Explorer shows any
licence message the server returns. Native backup and restore come with a Commercial
licence, and after a licence expires you can still read and download backups while writes
and restores wait for the renewed key. See [licence setup](../operations/licensing.md).

## Related articles

[Docker Compose](../operations/docker.md) · [Authentication and roles](../operations/authentication.md) · [Server configuration](../operations/configuration.md)
