Install local version of the Annotation Tool

[cglynos]

Hello,

I have tried to follow the instructions that describe how to install the annotation tool locally using Docker, but all attempts have failed.

Reproduction scenario:

1. git clone https://github.com/deepset-ai/haystack.git
2. cd haystack
3. python -m pip install -e '.[all-gpu]' # I used the latest version to develop a project and, now, I want to use the annotation tool to create a custom dataset, thus the following checkout to an older release.
4. git checkout v1.26.x
5. docker-compose pull
6. Configured the credentials and the database in the docker-compose.yml as follows:

version: "3"
services:
  backend:
    image: deepset/haystack-annotation:latest
    environment:
      NODE_ENV: "production"
      DB_HOSTNAME: "db"
      DB_NAME: "databasename"
      DB_USERNAME: "somesafeuser"
      DB_PASSWORD: "somesafepassword"
      # IMPORTANT: please configure credentials with secure strings.
      DEFAULT_ADMIN_EMAIL: "[email protected]"
      DEFAULT_ADMIN_PASSWORD: "DEMO_PASSWORD"
      COOKIE_KEYS: "somesafecookiekeys"
      JWT_SECRET: "somesafesecret"
      DOMAIN_WHITELIST: "1"
    ports:
      - "7001:7001"
    links:
      - "db:database"
    depends_on:
      - db
    networks:
      - app-network
    restart: unless-stopped

  db:
    image: "postgres:12"
    environment:
      POSTGRES_USER: "somesafeuser"
      POSTGRES_PASSWORD: "somesafepassword"
      POSTGRES_DB: "databasename"
    ports:
      - "5432:5432"
    volumes:
      - ./postgres-data:/var/lib/postgresql/data
    networks:
      - app-network
    healthcheck:
      test: "pg_isready --username=somesafeuser --dbname=databasename && psql --username=somesafeuser --list"
      timeout: 3s
      retries: 5
    restart: unless-stopped

networks:
  app-network:
    driver: bridge

7. docker-compose up
8. Chrome browser: http://localhost:7001

Results (screenshots):

What am I missing from this process? There's nothing else mentioned on the website.
Can you please help?

[anakin87]

Looking at the screenshot, it seems you have started the wrong Docker Compose stack (this).

Given your setup (Haystack 1.26.x), I would do the following (from the project root folder):

• cd haystack/annotation_tool
• docker compose up

[anakin87]

This seems a common issue with Docker on Windows

See https://www.google.com/search?q=mkdir+Access+is+denied.+docker+windows

This might solve your problem: docker/for-win#3385 (comment)

[cglynos]

I manually created this directory and tried again, which brought up the following errors:

annotation_tool-backend-1  | Sequelize CLI [Node: 10.24.1, CLI: 5.5.1, ORM: 5.22.5]
annotation_tool-backend-1  |
annotation_tool-backend-1  | Loaded configuration file "config/config.sequlize.js".
annotation_tool-backend-1  | Using environment "production".
annotation_tool-backend-1  |
annotation_tool-backend-1  |
annotation_tool-backend-1  | ERROR: getaddrinfo EAI_AGAIN db db:5432
annotation_tool-backend-1  | npm ERR! code ELIFECYCLE
annotation_tool-backend-1  | npm ERR! errno 1
annotation_tool-backend-1  | npm ERR! [email protected] migrate:up: `./node_modules/sequelize-cli/lib/sequelize db:migrate `
annotation_tool-backend-1  | npm ERR! Exit status 1
annotation_tool-backend-1  | npm ERR!
annotation_tool-backend-1  | npm ERR! Failed at the [email protected] migrate:up script.
annotation_tool-backend-1  | npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
annotation_tool-backend-1  |
annotation_tool-backend-1  | npm ERR! A complete log of this run can be found in:
annotation_tool-backend-1  | npm ERR!     /home/node/.npm/_logs/2024-10-23T12_28_51_447Z-debug.log
annotation_tool-backend-1  | [INFO  tini (1)] Spawned child process './entrypoint.sh' with pid '7'
annotation_tool-backend-1  | [INFO  tini (1)] Main child exited normally (with status '1')
annotation_tool-backend-1 exited with code 1
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1 exited with code 1
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chmod: changing permissions of '/var/lib/postgresql/data': Permission denied
annotation_tool-db-1       | chown: changing ownership of '/var/lib/postgresql/data': Permission denied
annotation_tool-backend-1  | 
annotation_tool-backend-1  | > [email protected] migrate:up /home/node/app/backend
annotation_tool-backend-1  | > ./node_modules/sequelize-cli/lib/sequelize db:migrate 

[anakin87]

I think you should not create the directory, but try to give Docker full access to it as explained here: docker/for-win#3385 (comment)

[cglynos]

That did the trick!! Thank you very much! However, please update the documentation online and I will post this in the SO question for other people to see. :-)

[anakin87]

Can you tell me how you would update the documentation to make it more understandable?