Database operations

This article contains tips for how to work with the AliasVault PostgreSQL database in both production and development environments.

Using install.sh helper methods (recommended)

The install.sh script contains helper methods that makes it easy to export and import databases with a simple single command.

Export database

# Export from normal database container (port 5432, production)
./install.sh db-export > aliasvault-db-export.sql.gz

# Export from dev database container (port 5433, development)
./install.sh db-export --dev > aliasvault-db-export.sql.gz

Import database

# Import to normal database container (port 5432, production)
./install.sh db-import < aliasvault-db-export.sql.gz

# Import to dev database container (port 5433, development)
./install.sh db-import --dev < aliasvault-db-export.sql.gz

Tip: you can also use the optional parameters --yes (to skip confirmation prompt) and --verbose (to get more output on what the operation is doing).

Using docker commands

Instead of using the `install.sh script, you can also use manual Docker commands.

Backup database to file

To backup the database to a file, you can use the following command:

docker compose exec postgres pg_dump -U aliasvault aliasvault | gzip > aliasvault.sql.gz

Import database from file

To drop the existing database and restore the database from a file, you can use the following command:

Executing this command will drop the existing database and restore the database from the file. Make sure to have a backup of the existing database before running this command.

docker compose exec postgres psql -U aliasvault postgres -c "DROP DATABASE aliasvault;" && \
docker compose exec postgres psql -U aliasvault postgres -c "CREATE DATABASE aliasvault;" && \
gunzip < aliasvault.sql.gz | docker compose exec -iT postgres psql -U aliasvault aliasvault

Change master password

By default during initial installation the PostgreSQL master password is set to a random string that is stored in the .env file with the POSTGRES_PASSWORD variable.

If you wish to change the master password, you can do so by running the following command:

Open a terminal and navigate to the root of the AliasVault repository.

Run the following command to connect to the PostgreSQL container:

 docker compose exec -it postgres psql -U aliasvault -d aliasvault

Once connected to the database, you can change the master password by running the following command:
```
 ALTER USER aliasvault WITH PASSWORD 'new_password';
```
Press Enter to confirm the changes.
Exit the PostgreSQL shell by running \q.
Manually update the .env file variable POSTGRES_PASSWORD with the new password.
Restart the AliasVault containers by running the following command:
```
 docker compose restart
```