Self-hosting with the prebuilt image

Prerequisites

To deploy the server with Docker you need docker and docker-compose installed. See the guide to installing Docker on all platforms.

On Ubuntu:

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-compose

Ports

Besides Docker, these ports must be reachable:

Port	Used by	Notes
`55230`	TCU communications	Must be accessible for the TCU to reach the server.
`80`	Navigation unit	HTTP only, since the navigation unit cannot handle SSL.

The web portal itself can use SSL by putting an Nginx or Apache server in front of it. See Running behind Nginx or Apache.

Installation and configuration

Clone the repository with git, or download the ZIP from GitHub:
Terminal window
```
git clone https://github.com/developerfromjokela/opencarwings.git
```
The only folder you need is carwings and its contents. Everything else is optional to keep.

Create docker-compose.yml next to the carwings folder, using this configuration:

version: "2.1"

services:
  server:
    image: ghcr.io/developerfromjokela/opencarwings:main
    container_name: opencarwings-server
    environment:
      PSQL_DATABASE: ${PSQL_NAME}
      PSQL_USER: ${PSQL_USERNAME}
      PSQL_PASSWORD: ${PSQL_PASSWORD}
      PSQL_DATABASE_HOST: db
      PSQL_DATABASE_PORT: 5432
      REDIS_HOST: redis
      REDIS_PORT: 6379
      TZ: ${TZ}
    restart: always
    volumes:
      - ./carwings/:/app/carwings/
      - ./staticfiles/:/app/staticfiles/
      - ./mediafiles/:/app/mediafiles/
      - ./logs/:/app/logs/
    ports:
      - "${BACKEND_PORT}:80"
      - "${TCPSERVER_PORT}:55230"
  db:
    image: postgres:14
    container_name: opencarwings-db
    environment:
      PGDATA: /var/lib/postgresql/data/pgdata
      POSTGRES_DB: ${PSQL_NAME}
      POSTGRES_USER: ${PSQL_USERNAME}
      POSTGRES_PASSWORD: ${PSQL_PASSWORD}
    volumes:
      - psql_data:/var/lib/postgresql/data
    restart: unless-stopped
  redis:
    container_name: opencarwings-redis
    image: redis:7

volumes:
  psql_data:

Create the .env file. Copy .example.env to .env in the same directory and edit it:

cp .example.env .env

Variable	Description
`TZ`	Server timezone, for example `Europe/Helsinki`.
`BACKEND_PORT`	Listening port for HTTP traffic, for example `0.0.0.0:80`.
`TCPSERVER_PORT`	Listening port for the TCU server.
`PSQL_NAME`	Database name. Keep the default.
`PSQL_USERNAME`	Database user name. Keep the default.
`PSQL_PASSWORD`	Database user password. Set your own, and generate a secure one with `uuidgen` or another high-entropy source.

Create the Django settings. Copy carwings/settings.docker.py to carwings/settings.py and modify it:

cp carwings/settings.docker.py carwings/settings.py

Setting	Description
`SECRET_KEY`	Generate a secure key with `uuidgen` or another high-entropy source.
`ALLOWED_HOSTS`	If you host the server behind a domain or IP address (local and/or WAN), add it to the list, for example `["domain.com", "domain2.com"]`.
`EMAIL_HOST`	SMTP email server address.
`EMAIL_USE_TLS`	`True` or `False`.
`EMAIL_PORT`	SMTP email server port.
`EMAIL_HOST_USER`	Email account user name.
`EMAIL_HOST_PASSWORD`	Email account password.

Start the server:
Terminal window
```
docker-compose up -d
```

Create an admin account:

docker exec -it opencarwings-server python manage.py createsuperuser

Check that it works. The admin interface is available at /admin. Log in and confirm everything is operational.
Disable debug mode. In carwings/settings.py, set DEBUG to False, then restart the server:
Terminal window
```
docker-compose down && docker-compose up -d
```