diff --git a/.env.template b/.env.template new file mode 100644 index 000000000..3128795aa --- /dev/null +++ b/.env.template @@ -0,0 +1,4 @@ +# Populate and change this to .env +IMPORTER_DB_API_TOKEN= +IMPORTER_DB_API_URL= +PATE_TOKEN= diff --git a/README.md b/README.md index 92fcc4264..8d1f56d46 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,19 @@ To run Oodikone locally, you will need the following: - [Docker](https://docs.docker.com/install/) (version 20.10+), - [Docker Compose](https://docs.docker.com/compose/install/)(version 0.29+) and - [npm](https://docs.npmjs.com/cli/v7) (version 7+) -2. Access to Toska Docker Hub, see Toska Gitlabs password document for more information on how to login -3. (Optional) For real data setup, access to Toskas production servers. +2. Access to Toska Docker Hub, +3. For real data setup, access to Toskas production servers. +4. For some features to work, access to Toskas service tokens ## 🚀 Installation -Launch the CLI and follow the instructions: +Pre-installation steps: + +- Clone this repo +- Login to toskas docker hub (see Toskas Gitlab for more information) +- Populate `.env.template` file with correct tokens and rename it to `.env` + +Then launch the CLI and follow the instructions: ```bash npm run cli diff --git a/docker-compose.yml b/docker-compose.yml index b418abb95..05f170bc5 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -5,7 +5,6 @@ x-build_defaults: &build_defaults target: development services: - adminer: <<: *defaults container_name: adminer @@ -27,6 +26,8 @@ services: - kone-db - redis - sis-db + env_file: + - .env environment: DB_URL_KONE: postgres://postgres@kone-db:5432/kone-db FRONT_URL: http://localhost:3000 @@ -70,11 +71,11 @@ services: redis: <<: *defaults - command: "redis-server --appendonly yes" + command: 'redis-server --appendonly yes' container_name: redis image: redis ports: - - "6379:6379" + - '6379:6379' volumes: - redis-data:/data @@ -97,7 +98,7 @@ services: sis-updater-nats: <<: *defaults - command: "-cid sis-updater-nats -m 8222 -p 4222 --max_age 2h --hb_fail_count 2 --hb_timeout 10s --hb_interval 10s --auth dev --file_slice_max_bytes 0 --file_slice_max_age 60s --max_msgs 0 -store file -dir datastore" + command: '-cid sis-updater-nats -m 8222 -p 4222 --max_age 2h --hb_fail_count 2 --hb_timeout 10s --hb_interval 10s --auth dev --file_slice_max_bytes 0 --file_slice_max_age 60s --max_msgs 0 -store file -dir datastore' container_name: sis-updater-nats image: nats-streaming:0.16.2 profiles: