Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 3.52 KB

setup-docker.md

File metadata and controls

91 lines (60 loc) · 3.52 KB
Raw

Installation with Docker

Get the code

git clone https://github.com/hotosm/tasking-manager.git.

Configure

  • Copy the example configuration file to start your own configuration: cp example.env tasking-manager.env.
  • Adjust the tasking-manager.env configuration file to fit your configuration.

Public host

By default, things are made to work from localhost. If you want to setup a public host, try setting the following:

  • tasking-manager.env: TM_APP_BASE_URL=https://tasks.smartcitiestransport.com/
  • docker-compose.override.yml:
    • TM_APP_API_URL=https://tasks.smartcitiestransport.com/api
    • traefik.http.routers.frontend.rule=Host(`localhost`, `tasks.smartcitiestransport.com`)
  • docker-compose.yml:
    • traefik.http.routers.backend.rule=Host(`localhost`, `tasks.smartcitiestransport.com`) && PathPrefix(`/api/`)
    • traefik.http.routers.frontend.rule=Host(`localhost`, `tasks.smartcitiestransport.com`)

Persistent data

If you may be removing and starting the postgresql container, you may want to setup a persistent volume:

In docker-compose.override.yml:

services:
  postgresql:
    volumes:
      - "postgresql-data:/var/lib/postgresql/data"

volumes:
  postgresql-data:

Connect with OpenStreetMap

The Tasking Manager uses OpenStreetMap accounts for users to login.

In order to configure this connection you have to go to https://www.openstreetmap.org/user/<Your_OSM_UserName>/oauth_clients/new and fill in the form:

Required OSM OAuth settings

Afterwards copy the consumer key and secret from OpenStreetMap into your configuration file tasking-manager.env, and set the two variables: TM_CONSUMER_KEY and TM_CONSUMER_SECRET.

NB: if you've configured a custom OSM server, make sure that you create the user and oAuth client there.

Run the Tasking Manager

The easiest way to run the Tasking Manager requires Docker and Docker Compose to be installed on your system. Afterwards you'll just need:

  • One command to get everything together and start the Tasking Manager: docker-compose up -d
  • Visit with your browser http://127.0.0.1:5000

For stopping this command do the job: docker-compose stop And you can check the logs with docker-compose logs -f

Alternatively you can review how to install a development setup.

Working with the setup

The Tasking Manager Docker setup comes with pre-built client modules and backend requirements. To start all required services to run tasking manager locally, run

make up

Also, you can edit and execute client tests with make test-client. For backend tests you need to run make test-backend. For both, the command is make tests.

With this approach users and developers have the possibility to review and setup their own instance of tasking manager without the need of installation or configuration of the resources. Hence, it becomes possible to examine Pull requests, executing

make PRNUMBER=prnumber

where prnumber corresponds to the pull request number created on github.

Finally, to destroy running containers for all services, please run

make down

Notes.

  1. It is important to set the hotosm/tasking-manager remote as origin.
  2. When a new frontend module or backend requirement is included within their respective files, remember to rebuild dockerfile image, executing the following command
make build