Any questions, problems or suggestions with this guide? Ask a question in our community or contribute the change yourself at https://gitlab.com/bramw/baserow/-/tree/develop/docs .
The following config is the easiest way of deploying Baserow with docker-compose and just uses the all-in-one image and a single container. If you use this config then you should instead refer to the Install with Docker guide on the specifics of how to work with this image.
version: "3.4" services: baserow: container_name: baserow image: baserow/baserow:1.14.0 environment: BASEROW_PUBLIC_URL: 'http://localhost' ports: - "80:80" - "443:443" volumes: - baserow_data:/baserow/data volumes: baserow_data:
The rest of this guide will instead deal with the default
found in the root of our git repository which runs each Baserow service as a separate
If you haven’t already installed docker and docker-compose on your computer you can do so by following the instructions on https://docs.docker.com/desktop/ and https://docs.docker.com/compose/install/.
Docker-compose version 1.19.0 and Docker version 19.03 are the minimum versions required by our provided files.
You can download the example Baserow
docker-compose.yml by either directly downloading
the file from
curl -o docker-compose.yml https://gitlab.com/bramw/baserow/-/raw/master/docker-compose.yml curl -o .env https://gitlab.com/bramw/baserow/-/raw/master/.env.example curl -o Caddyfile https://gitlab.com/bramw/baserow/-/raw/master/Caddyfile # Edit .env and set your own secure passwords for the 3 required variables at the top. gedit .env docker-compose up -d
or by directly cloning our git repo so you can get updates easier:
cd ~/baserow git clone --depth=1 --branch master https://gitlab.com/bramw/baserow.git cd baserow cp .env.example .env # Edit .env and set your own secure passwords for the 3 required variables at the top. gedit .env docker-compose up -d # To update to the latest run: docker-compose down git pull docker-compose up -d
There is a security flaw with docker and the ufw firewall. By default docker when exposing ports on 0.0.0.0 will bypass any ufw firewall rules and expose the above container publicly from your machine on its network. If this is not intended then please set HOST_PUBLISH_IP to 127.0.0.1 so Baserow can only be accessed from the machine it is running on. Please see https://github.com/chaifeng/ufw-docker for more information and how to setup ufw to work securely with docker.
To use this docker-compose.yml to run Baserow you must set the three
REDIS_PASSWORD. See the
section below for more details. If you receive the following error it is because you
need to set the required environment variables first:
ERROR: Missing mandatory value for "environment" option interpolating
If you are upgrading from Baserow 1.8.2 or earlier please read the additional section below.
See Configuring Baserow for information on the other environment variables you can configure.
You can set these variables by using docker-compose env file (https://docs.docker.com/compose/environment-variables/#the-env-file):
.env.examplefile found in the root of Baserows repository (https://gitlab.com/bramw/baserow/-/blob/master/.env.example) to
curl -o .env https://gitlab.com/bramw/baserow/-/raw/master/.env.example
.envand provide values for the missing environment variables.
Alternatively you can set these variables by either running docker-compose with the environment variables set on the command line (fill in secure values first):
SECRET_KEY= DATABASE_PASSWORD= REDIS_PASSWORD= docker-compose up
docker-compose up -d
docker-compose logs -f
[BASEROW-WATCHER][2022-05-10 08:44:46] Baserow is now available at ...
If you were previously using a separate api.your_baserow_server.com domain this is no longer needed. Baserow will now work on a single domain accessing the api at YOUR_DOMAIN.com/api.
To upgrade from 1.8.2’s docker-compose file from inside the Baserow git repo you need to:
.envfilling in the missing variables below:
SECRET_KEYto a secure value, existing logins sessions will be invalidated.
DATABASE_PASSWORDto a secure password (this defaulted to ‘baserow’ before, in step 3 we are going to change the database users password to the value you set)
REDIS_PASSWORDto a secure password.
WEB_FRONTEND_PORTback to 3000 if you want to continue accessing Baserow on that port (it now defaults to 80).
BASEROW_PUBLIC_URLto the URL/IP/Domain you were using access Baserow remotely (it must begin with http:// or https://). If you have set
WEB_FRONTEND_PORTto anything but 80 you must append it to the end of
BASEROW_CADDY_ADDRESSESconfigures which addresses the new internal Caddy reverse proxy listens on. By default, it will serve http only, enable automatic https by setting to
,http://localhostif you still want to be able to access Baserow from
docker-compose run --rm backend bash -c "PGPASSWORD=baserow psql -h db -U baserow -c \"ALTER USER baserow WITH PASSWORD '$DATABASE_PASSWORD';\" && echo 'Successfully changed Baserow's db user password'"
docker-compose up -d
You can see and run the Baserow backend management commands like so:
docker-compose exec backend /baserow/backend/docker/docker-entrypoint.sh help
$ docker-compose logs
Baserow’s docker-compose files will automatically expose the
caddy service on your
network on ports 80 and 433 by default. If you already have applications or services
using those ports the Baserow service which uses that port will crash. To fix this you
can set the
WEB_FRONTEND_PORT variable to change the default of port 80 and
WEB_FRONTEND_SSL_PORT to change the default port of 443.
$ WEB_FRONTEND_SSL_PORT=444 WEB_FRONTEND_PORT=3000 docker-compose up
If you have a domain name and have correctly configured DNS then you can run the following command to make Baserow available at the domain with automatic https provided by Caddy.
,http://localhostto BASEROW_CADDY_ADDRESSES if you still want to be able to access your server from the machine it is running on using http://localhost. See Caddy’s Address Docs for all supported values for BASEROW_CADDY_ADDRESSES.
BASEROW_PUBLIC_URL=https://www.REPLACE_WITH_YOUR_DOMAIN.com \ BASEROW_CADDY_ADDRESSES=https://www.REPLACE_WITH_YOUR_DOMAIN.com \ docker-compose up
WEB_FRONTEND_SSL_PORT= \ BASEROW_PUBLIC_URL=https://www.REPLACE_WITH_YOUR_DOMAIN.com \ docker-compose up
WEB_FRONTEND_PORT=3000 \ BASEROW_PUBLIC_URL=https://www.REPLACE_WITH_YOUR_DOMAIN.com:3000 \ docker-compose up
You can disable automatic migration by setting the
false (or any value which is not
true) like so:
MIGRATE_ON_STARTUP=false docker-compose up -d
# Use run if you have stopped your docker-compose environment docker-compose run backend manage migrate # Use exec otherwise docker-compose exec backend /baserow/backend/docker/docker-entrypoint.sh manage migrate
You can disable automatic baserow template syncing by setting the
BASEROW_TRIGGER_SYNC_TEMPLATES_AFTER_MIGRATION environment variable to
false (or any
value which is not
true) like so:
BASEROW_TRIGGER_SYNC_TEMPLATES_AFTER_MIGRATION=false docker-compose up -d
docker-compose run backend manage backup_baserow --help.
mkdir ~/baserow_backups # The folder must be the same UID:GID as the user running inside the container, which # for the local env is 9999:9999, for the dev env it is 1000:1000 or your own UID:GID # when using ./dev.sh sudo chown 9999:9999 ~/baserow_backups/ docker-compose run -v ~/baserow_backups:/baserow/backups backend backup -f /baserow/backups/baserow_backup.tar.gz # backups/ now contains your Baserow backup.
docker-compose run backend manage restore_baserow --help
docker-compose run -v ~/baserow_backups:/baserow/backups backend restore -f /baserow/backups/baserow_backup.tar.gz