Host your own instance of NearBeach in Docker or Podman
The following documentation is a guide on how to install NearBeach using Docker compose or podman compose. You will be able to find more information in our docs.
Step 1 - Copy code
Please copy the example code into a text editor of your choice
Step 2 - Variables
Please fill out the appropriate details for the following fields;
- SMTP_EMAIL_HOST
- SMTP_EMAIL_PORT
- SMTP_EMAIL_HOST_USER
- SMTP_EMAIL_HOST_PASSWORD
- ADMIN_USERNAME
- ADMIN_EMAIL
Step 3 - Databases
Please fill out the appropriate details for the following fields. Please note that the following fields will require the exact same values.
- DB_DATABASE / MARIADB_DATABASE
- DB_USER / MARIADB_USER
- DB_PASSWORD / MARIADB_PASSWORD
- MARIADB_ROOT_PASSWORD
Step 4 - Setup CSRF Trusted Urls
Fill out the following field with the domain you are going to use for your NearBeach Instance;
- ALLOWED_HOSTS=yourdomain.com.au
- CSRF_TRUSTED_URLS=https://yourdomain.com.au
Please note the https on the CSRF token - it is recommended to use https when using NearBeach.
Please note - Allowed hosts do not need the protocol.
Please note - If you need multiple domain for either field, please use a comma (,) to separate them.
- ALLOWED_HOSTS=yourdomain.com.au,www.yourdomain.com.au
Step 5 - Azure Blob Storage
Use your Azure Blob storage to store uploaded files from NearBeach. If you don't require Azure Blob storage, please delete these two lines.
Step 6 - Save
Save the file in an appropriate location called "docker-compose.yml". Alternatively if you are using podman, please save the file as "podman-compose.yml".
Step 7 - Run Docker/Podman Compose
Using a terminal, change directory to the location that you stored the docker-compose file. Run the following command: "docker-compose up -D". Alternatively if you are using podman, run the following command: "podman-compose up -d"