Once EdgeDB has been installed using one of the methods described in the Installation section, a couple of initial setup steps are necessary in order to start using it.
If you have installed EdgeDB using a pre-built package, a default
system-wide instance would have been created
N is the major version
of EdgeDB). In this case you can skip this section and refer to
the installation section appropriate for your OS.
To use EdgeDB you must first create an instance. An EdgeDB instance is a collection of databases that is managed by a particular running EdgeDB server. The data managed by the instance is usually stored in a single directory, which is called the data directory.
The EdgeDB server creates and populates a data directory automatically
on the first run. The location of the data directory can be specified
$ edgedb-server -D /data/directory/path
The server would then populate the specified directory with the initial
<user>, where <user> the name of
the OS user that has started the server (if different from
Two corresponding user roles are also created:
both with superuser privileges.
By default, EdgeDB requires every connecting client to provide a password for authentication. There is no default password, so one must be set on a newly created instance:
$ edgedb --admin -h </data/dir> alter role <username> --password
--admin option instructs the
edgedb command to connect to
the server using a dedicated administrative socket that does not require
password authentication, but is protected by the OS permissions.
--admin option can only be used by the OS user that created the
server instance (or by OS superuser).