Skip to content

Latest commit

 

History

History
148 lines (107 loc) · 3.79 KB

README.md

File metadata and controls

148 lines (107 loc) · 3.79 KB

Backroll compose projects

The Docker Compose projects enable Backroll to be available in several modes :

  • for developpement :
    • dev:
      • no configuration (default values)
      • uses the Docker Compose network
    • staging:
      • you will go through the configuration steps
      • uses your local network
  • for production : prod

The helper script

In the compose_project/ directory, the script source-me.sh helps you to configure and run Backroll :

  • ensure that you are in the compose_project/ directory :

    cd compose_project

  • source the script source-me.sh :

    • only get argument variables : 
      source source-me.sh
    • get argument variables and setup dev : 
      source source-me.sh setup-dev
    • get argument variables and setup staging : 
      source source-me.sh setup-staging
    • get argument variables and setup prod : 
      source source-me.sh setup-prod

  • use docker compose with an argument variable :

    • dev version : 
      docker compose $dev [options] [COMMAND] [ARGS...]
    • staging version : 
      docker compose $staging [options] [COMMAND] [ARGS...]
    • prod version : 
      docker compose $prod [options] [COMMAND] [ARGS...]

Remember to always be in the compose_project/ directory and to source source-me.sh in your terminal.

Examples

dev

cd compose_project
source source-me.sh setup-dev
docker compose $dev up

staging

cd compose_project
source source-me.sh setup-staging
docker compose $staging up

prod

cd compose_project
source source-me.sh setup-prod
docker compose $prod up

User interface

The user interface is made up of several components :

  • the Backroll front
  • the Flower web application to monitor and manage the Celery tasks
  • the Keycloak SSO admin console

Accessing the dev UI

Proxy setup

To access the various containers’ web interfaces, your internet browser needs to get into the compose project network.

Running the proxy server

Create a proxy server by connecting to the proxy container:

ssh -p 2222 -D 1080 developer@localhost

The password is developer. You must ensure that the command is running each time you start working on Backroll.

If you are working remotely, do not forget to forward the port 2222.

Keep in mind that the port 2222 may be already in use. Run the docker port command on the proxy container to find the exposed port.

Connecting to the proxy server

Now you need to configure your web browser to use the SOCKS v5 proxy at address localhost port 1080 and to use the proxy DNS. Feel free to use another port if it is more convenient for you.

For Firefox, see Connection settings in Firefox :

  • choose “Manual proxy configuration”
  • fill in “SOCKS Host” and “Port”
  • choose “SOCKS v5”
  • check “Proxy DNS when using SOCKS v5”

URLs and credentials

Backroll :

Keycloak :

Flower :

Accessing the staging or prod UI

You can acces to the user interfaces on localhost :