backofficeapp/back-office repository overview

⁠Getting started

Your back office is delivered in on-premise mode. This distribution method allows you to host your application yourself and maintain control over your data. To do this, you need to install your back office on your IT system.

⁠Server installation

The server installation takes place in a few minutes via docker⁠. You can use the following docker command to start immediately:

docker run --name back-office \
           -p 3000:3000 \
           -v storage:/back-office/storage \
           -v credentials:/back-office/config/credentials \
           -v clamav:/var/lib/clamav \
           backofficeapp/back-office:latest

Or you can also create a docker-compose.yml file:

name: back-office
services:
  web:
    image: backofficeapp/back-office:latest
    ports:
      - 3000:3000
    volumes:
      - credentials:/back-office/config/credentials
      - storage:/back-office/storage
      - clamav:/var/lib/clamav
volumes:
  credentials:
  storage:
  clamav:

You can find more docker-compose files, with different image versions, here⁠.

Then issue the command to create the containers:

docker-compose up --build

⁠First time login

Once the server is installed, you may connect to the pre-configured account. Here are the credentials:

For security reasons, it is strongly advised to change these credentials after the first login.

⁠Additional configuration

In order to be able to use all the features of your back office, it is recommended to provide a set of API keys that unlock AI, translation, email sending, and cloud file storage features.

It is also recommended to provide the URL of the application that will be used to generate all the links for your back office.

You can find more explanation in the associated documentation⁠.