EdgeDB Cloud is currently in beta. This guide will not work unless you have access. To request access, join the waitlist or join our Discord and request access there.
EdgeDB Cloud is the easiest way to host your EdgeDB instance. We offer two ways to interact with EdgeDB Cloud: via our CLI or through a graphical web interface.
To use Cloud via the CLI, first log in using edgedb cloud login. Once your login is successful, you will be able to create an instance using either edgedb instance create or edgedb project init, depending on whether you also want to create a local project linked to your instance.
edgedb instance create with an instance name of
<github-username>/<instance-name>.
$
edgedb instance create <github-username>/<instance-name>edgedb project init with the --server-instance option. Set
the server instance name to <github-username>/<instance-name>.
$
edgedb project init \
--server-instance <github-username>/<instance-name>Alternatively, you can run edgedb project init
without the
--server-instance option and enter an instance name in the
<github-username>/<instance-name> format when prompted interactively.
Please be aware of the following restrictions on EdgeDB Cloud instance names:
can contain only Latin alpha-numeric characters or -
cannot start with a dash (-) or contain double dashes (--)
maximum instance name length is 61 characters minus the length of your GitHub username (i.e., length of GitHub username + length of instance name must be fewer than 62 characters)
To use edgedb instance create:
$
edgedb instance create <github-username>/<instance-name>To use edgedb project init:
$
edgedb project init \
--server-instance <github-username>/<instance-name>Alternatively, you can run edgedb project init
without the
--server-instance option and enter an instance name in the
<github-username>/<instance-name> format when prompted interactively.
If you’d prefer, you can also manage your account via the EdgeDB Cloud web-based GUI.
The first time you access the web UI, you will be prompted to log in. Once you log in with your GitHub account, you’ll see your instance list.
If this is your first time accessing EdgeDB Cloud, this list will be empty. To create an instance, click “Create new instance.” This will pop up a modal allowing you to name your instance and specify the version of EdgeDB and the region for the instance.
Once the instance has been created, you’ll see the instance dashboard which allows you to monitor your instance, navigate to the database management page, and create secret keys.
You’ll also see instructions in the bottom-right for linking your EdgeDB CLI to
your EdgeDB Cloud account. You do this by running the CLI command edgedb
cloud login. This will make all of your EdgeDB Cloud instances accessible via
the CLI. You can manage them just as you would other remote EdgeDB instances.
If you want to manage your database, click through on its name from the top right of the instance dashboard. If you just created your database, the database management view will be mostly empty except for a button offering to create a sample database. Once you have a schema created and some data in a database, this view will offer you similar tools to those in our new 3.0 local UI.
You’ll be able to access a REPL, edit complex queries or build them graphically, inspect your schema, and browse your data.
For your production deployment, generate a dedicated secret key for your instance with edgedb cloud secretkey create or via the web UI’s “Secret Keys” pane in your instance dashboard. Create two environment variables accessible to your production application:
EDGEDB_SECRET_KEY- contains the secret key you generated
EDGEDB_INSTANCE- the name of your EdgeDB Cloud instance
(<github-username>/<instance-name>)
Thank you for helping us make the best way to host your EdgeDB instances even better!
Please join us on our Discord to ask questions.
If you’re having problems, check our status page for information about any service interruptions.
Report any bugs you find by submitting a support ticket.
