Light
Dark
System

Deploying EdgeDB to a Bare Metal Server

In this guide we show how to deploy EdgeDB to bare metal using your system’s package manager and systemd.

The steps for installing the EdgeDB package will be slightly different depending on your Linux distribution. Once you have the package installed you can jump to Enable a systemd unit.

Import the EdgeDB packaging key.

Copy
$ 
  
  
  
sudo mkdir -p /usr/local/share/keyrings && \
  sudo curl --proto '=https' --tlsv1.2 -sSf \
  -o /usr/local/share/keyrings/edgedb-keyring.gpg \
  https://packages.edgedb.com/keys/edgedb-keyring.gpg

Add the EdgeDB package repository.

Copy
$ 
  
  
  
echo deb [signed-by=/usr/local/share/keyrings/edgedb-keyring.gpg] \
  https://packages.edgedb.com/apt \
  $(grep "VERSION_CODENAME=" /etc/os-release | cut -d= -f2) main \
  | sudo tee /etc/apt/sources.list.d/edgedb.list

Install the EdgeDB package.

Copy
$ 
sudo apt-get update && sudo apt-get install edgedb-2

Add the EdgeDB package repository.

Copy
$ 
  
  
sudo curl --proto '=https' --tlsv1.2 -sSfL \
 https://packages.edgedb.com/rpm/edgedb-rhel.repo \
 > /etc/yum.repos.d/edgedb.repo

Install the EdgeDB package.

Copy
$ 
sudo yum install edgedb-2

The EdgeDB package comes bundled with a systemd unit that is disabled by default. You can start the server by enabling the unit.

Copy
$ 
sudo systemctl enable --now edgedb-server-2

This will start the server on port 5656, and the data directory will be /var/lib/edgedb/1/data.

edgedb-server cannot be run as root.

To set environment variables when running EdgeDB with systemctl,

Copy
$ 
systemctl edit --full edgedb-server-2

This opens a systemd unit file. Set the desired environment variables under the [Service] section. View the supported environment variables at Reference > Environment Variables.

Copy
[Service]
Environment="EDGEDB_SERVER_TLS_CERT_MODE=generate_self_signed"
Environment="EDGEDB_SERVER_ADMIN_UI=enabled"

Save the file and exit, then restart the service.

Copy
$ 
systemctl restart edgedb-server-2

There is no default password. Set a password by connecting from localhost.

Copy
$ 
echo -n "> " && read -s PASSWORD
Copy
$ 
  
sudo edgedb --port 5656 --tls-security insecure --admin query \
 "ALTER ROLE edgedb SET password := '$PASSWORD'"

The server listens on localhost by default. Changing this looks like this.

Copy
$ 
  
edgedb --port 5656 --tls-security insecure --password query \
 "CONFIGURE INSTANCE SET listen_addresses := {'0.0.0.0'};"

The listen port can be changed from the default 5656 if your deployment scenario requires a different value.

Copy
$ 
  
edgedb --port 5656 --tls-security insecure --password query \
 "CONFIGURE INSTANCE SET listen_port := 1234;"

You may need to restart the server after changing the listen port or addresses.

Copy
$ 
sudo systemctl restart edgedb-server-2

The command groups edgedb instance and edgedb project are not intended to manage production instances.

When you want to upgrade to the newest point release upgrade the package and restart the edgedb-server-2 unit.

Copy
$ 
sudo apt-get update && sudo apt-get install --only-upgrade edgedb-2
Copy
$ 
sudo systemctl restart edgedb-server-2
Copy
$ 
sudo yum update edgedb-2
Copy
$ 
sudo systemctl restart edgedb-server-2

Using an HTTP client, you can perform health checks to monitor the status of your EdgeDB instance. Learn how to use them with our health checks guide.

Light
Dark
System