Deploying EdgeDB to a Bare Metal Server​

Install the EdgeDB Package​

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.

$ 
  
  
  

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

$ 
  
  
  

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

$ 

sudo apt-get update && sudo apt-get install edgedb-3

$ 
  
  

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

$ 

sudo yum install edgedb-3

Enable a systemd unit​

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

$ 

sudo systemctl enable --now edgedb-server-3

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

Set environment variables​

To set environment variables when running EdgeDB with systemctl,

$ 

systemctl edit --full edgedb-server-3

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

[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.

$ 

systemctl restart edgedb-server-3

Set a password​

There is no default password. To set one, you will first need to get the Unix socket directory. You can find this by looking at your system.d unit file.

$ 

sudo systemctl cat edgedb-server-3

Set a password by connecting from localhost.

$ 

echo -n "> " && read -s PASSWORD

$ 
  
  

RUNSTATE_DIR=$(systemctl show edgedb-server-3 -P ExecStart | \
 grep -o -m 1 -- "--runstate-dir=[^ ]\+" | \
 awk -F "=" '{print $2}')

$ 
  
  

sudo edgedb --port 5656 --tls-security insecure --admin \
 --unix-path $RUNSTATE_DIR \
 query "ALTER ROLE edgedb SET password := '$PASSWORD'"

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

$ 
  

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.

$ 
  

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.

$ 

sudo systemctl restart edgedb-server-3

Link the instance with the CLI​

The following is an example of linking a bare metal instance that is running on localhost. This command assigns a name to the instance, to make it more convenient to refer to when running CLI commands.

$ 
  
  
  
  
  
  

edgedb instance link \
 --host localhost \
 --port 5656 \
 --user edgedb \
 --database edgedb \
 --trust-tls-cert \
 bare_metal_instance

This allows connecting to the instance with its name.

$ 

edgedb -I bare_metal_instance

Upgrading EdgeDB​

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

$ 

sudo apt-get update && sudo apt-get install --only-upgrade edgedb-3

$ 

sudo systemctl restart edgedb-server-3

$ 

sudo yum update edgedb-3

$ 

sudo systemctl restart edgedb-server-3

Health Checks​

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.