Quick Install with Docker

Copy the following code and paste it into a file called docker-compose.yaml

version: '3'

services:
    db:
        image: mariadb:10.11
        container_name: nearbeach-db
        ports:
        - 3306:3306
        environment:
        - MARIADB_DATABASE=<<Please fill>>
        - MARIADB_USER=<<Please fill>>
        - MARIADB_PASSWORD=<<Please fill>>
        - MARIADB_ROOT_PASSWORD=<<Please fill>>
        volumes:
        - ./init:/docker-entrypoint-initdb.d
    nearbeach:
        image: robotichead/nearbeach:latest
        container_name: nearbeach
        environment:
        - SECRET_KEY=<<Please fill>>
        - SMTP_EMAIL_HOST=<<Please fill>>
        - SMTP_EMAIL_PORT=<<Please fill>>
        - SMTP_EMAIL_HOST_USER=<<Please fill>>
        - SMTP_EMAIL_HOST_PASSWORD=<<Please fill>>
        - DB_DATABASE=<<Please fill>>
        - DB_USER=<<Please fill>>
        - DB_PASSWORD=<<Please fill>>
        - DB_HOST=nearbeach-db
        - DB_ENGINE=mysql
        - DB_PORT=3306
        - ADMIN_USERNAME=<<Please fill>>
        - ADMIN_EMAIL=<<Please fill>>
        - CSRF_TRUSTED_URLS=<<https://yourdomain.com.au>>
        - AZURE_STORAGE_CONNECTION_STRING=<<Please fill>>
        - AZURE_STORAGE_CONTAINER_NAME=<<Please fill>>
        volumes:
        - .:/ceansuite
        ports:
        - 8000:8000
        - 2525:2525
        command: >
            sh -c "python manage.py wait_for_database &&
                ls -al &&
                python manage.py migrate &&
                python manage.py initadmin &&
                python manage.py runserver 0.0.0.0:8000"
        restart: unless-stopped
        depends_on:
        - db

1. Fill out the following fields appropriately.

   SMTP is used to send the reset password functionality required to login for the first time.

   • SMTP_EMAIL_HOST
   • SMTP_EMAIL_PORT
   • SMTP_EMAIL_HOST_USER
   • SMTP_EMAIL_HOST_PASSWORD
   • ADMIN_USERNAME
   • ADMIN_EMAIL

   The administration username will be used to log into NearBeach.

2. Fill out the database connection. Please note you will need the same variable value for the following pairs;

   • DB_DATABASE / MARIADB_DATABASE
   • DB_USER / MARIADB_USER
   • DB_PASSWORD / MARIADB_PASSWORD
   • MARIADB_ROOT_PASSWORD

3. Fill out the CSRF_TRUSTED_URLS value. This will need to be the EXACT domain. Please view the examples below

   CSRF_TRUSTED_URLS=https://demo.nearbeach.org
   

4. Use your Azure Blob storage to store uploaded files from NearBeach. If you don’t require Azure Blob storage, please delete these two lines.

5. Using a terminal, change directory to the location that you stored the docker-compose file. Run the following command: “docker-compose up -D”

You are now up and running NearBeach on your local environment. Visiting http://localhost:8000 in your browser will take you to NearBeach