NearBeach - An Open Source project managment system

Step 1

Please copy the example code into a text editor of your choice

Step 2

Please fill out the appropriate details for the following fields;
- MARIADB_DATABSE
- MARIADB_MYSQL_LOCALHOST_USER
- MARIADB_PASSWORD
- MARIADB_ROOT_PASSWORD
- SMTP_EMAIL_HOST
- SMTP_EMAIL_PORT
- SMTP_EMAIL_HOST_USER
- SMTP_EMAIL_HOST_PASSWORD
- ADMIN_USERNAME
- ADMIN_EMAIL

Step 3

Fill out the following field with the domain you are going to use for your NearBeach Instance;
- CSRF_TRUSTED_URLS=https://yourdomain.com.au
Please note the https - it is recommended to use https when using NearBeach.

Step 4

Please fill out the appropriate details for the following fields;
- MYSQL_DATABASE
- MYSQL_USER
- MYSQL_PASSWORD
Please note - these particular fields should match the fields stated inside the docker-compose file.

Step 5

Save the file in an appropriate location called "docker-compose.yml"

Step 6

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

Step 7 (optional)

If you would like to deploy NearBeach docker to a webserver, you can following the instructions on Nginx's blog

version: '3'

services:
    db:
        image: mariadb:latest
        container_name: nearbeach-db
        ports:
        - 3306:3306
        environment:
        - MARIADB_DATABASE=<<Please fill>>
        - MARIADB_MYSQL_LOCALHOST_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=8uweh9Q0QEdh5B0x
        - SMTP_EMAIL_HOST=<<Please fill>>
        - SMTP_EMAIL_PORT=<<Please fill>>
        - SMTP_EMAIL_HOST_USER=<<Please fill>>
        - SMTP_EMAIL_HOST_PASSWORD=<<Please fill>>
        - MYSQL_DATABASE=<<Same as MARIADB_DATABASE>>
        - MYSQL_USER=<<Same as MARIADB_MYSQL_LOCALHOST_USER>>
        - MYSQL_PASSWORD=<<Same as MARIA_PASSWORD>>
        - MYSQL_HOST=nearbeach-db
        - ADMIN_USERNAME=<<Please fill>>
        - ADMIN_EMAIL=<<Please fill>>
        - CSRF_TRUSTED_URLS=<<https://yourdomain.com.au>>
        volumes:
        - .:/ceansuite
        ports:
        - 8000:8000
        - 2525:2525
        restart: unless-stopped
        depends_on:
        - db