Cattr installation notes

[vermorag]

For Cattr installation you need to use the official Docker image from Cattr Registry. Basically, all versions are tagged with v... tag. So, for example, you can use: registry.git.amazingcat.net/cattr/core/app:v4.0.0-RC47.

The docker image contains everything, except the database. So you'll need an external database or docker-compose to make it work.
So, for example, your docker-compose.yml file can look like this:

version: "3.9"

services:
  app:
    image: registry.git.amazingcat.net/cattr/core/app:v4.0.0-RC47  
    restart: unless-stopped
    ports:
      - "80:80"
    depends_on:
      db:
        condition: service_healthy
    volumes:
      - ./storage:/app/storage
    networks:
      - default
    environment:
      - DB_USERNAME=root
      - DB_PASSWORD=password
      - APP_KEY=base64:lg1m/12MHBbBpiWTXjot98Q9MP/nSzPrvLEU2beD+2Y=

  db:
    image: mysql:latest
    restart: unless-stopped
    environment:
      - MYSQL_DATABASE=cattr
      - MYSQL_ROOT_PASSWORD=password
    cap_add:
      - SYS_NICE
    volumes:
      - ./data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
      timeout: 20s
      retries: 10

Cattr can work with percona/mysql/mariadb, so you're free to choose any. All env variables, that will be used for DB connection you can check in config/database.php.
Also, it will be a good option to set APP_KEY for artisan on the compose level to persist it between restarts. Pay attention to the mounted folder /app/storage - it will store your screenshots and data, needed for persistence.

On first install Cattr will create an admin with the name Admin, login admin@cattr.app and password password, but you are free to change it with env variables APP_ADMIN_EMAIL, APP_ADMIN_PASSWORD and APP_ADMIN_NAME.

If you want to use HTTPS, you'll need to setup nginx on your server for proxying requests to Cattr container.
Your nginx site config can look like that:

server {
    listen 80;
    listen 443 ssl http2;
    listen [::]:80;
    listen [::]:443 ssl http2;
    server_name cattr.app www.cattr.app;

    ssl_certificate /etc/letsencrypt/live/cattr.app/fullchain.pem; 
    ssl_certificate_key /etc/letsencrypt/live/cattr.app/privkey.pem; 
    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;

    map $http_upgrade $connection_upgrade {
        default upgrade;
        ''      close;
    }

    location /  {
        proxy_pass http://127.0.0.1:8080/;
        proxy_set_header X-Real-IP  $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header Host $host;
        proxy_set_header X-Real-Port $server_port;
        proxy_set_header X-Real-Scheme $scheme;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
     }
}

That's all. You can ask any questions about Cattr installation in the thread.

[sepsol]

Thanks for the tutorial! I've tried using this docker-compose.yml file on my WSL2 (Ubuntu 20.04). It is running without any issues, but when I go back to my WIndows 11 and try to open http://localhost:80 in my browser, I get nginx: 502 Bad Gateway. I am not using nginx or https in my barebones setup. I tried connect to the app's shell to further troubleshoot as well but got this:

$ docker exec -it cattr-app-1 /bin/bash
OCI runtime exec failed: exec failed: unable to start container process: exec: "/bin/bash": stat /bin/bash: no such file or directory: unknown

[vermorag]

Hello.
app container doesn't have bash inside. Try /bin/sh.
Also, check logs at docker compose logs app and inside the folder storage/logs.

[sepsol]

There are no files inside the storage/logs folder. But here are the logs from docker.

$ docker compose logs

cattr-db-1  | 2023-11-10 06:28:44+00:00 [Note] [Entrypoint]: Entrypoint script for MySQL Server 8.2.0-1.el8 started.
cattr-db-1  | 2023-11-10 06:28:45+00:00 [Note] [Entrypoint]: Switching to dedicated user 'mysql'
cattr-db-1  | 2023-11-10 06:28:45+00:00 [Note] [Entrypoint]: Entrypoint script for MySQL Server 8.2.0-1.el8 started.
cattr-db-1  | '/var/lib/mysql/mysql.sock' -> '/var/run/mysqld/mysqld.sock'
cattr-db-1  | 2023-11-10T06:28:45.277108Z 0 [System] [MY-015015] [Server] MySQL Server - start.
cattr-db-1  | 2023-11-10T06:28:45.502457Z 0 [Warning] [MY-011068] [Server] The syntax '--skip-host-cache' is deprecated and will be removed in a future release. Please use SET GLOBAL host_cache_size=0 instead.cattr-db-1  | 2023-11-10T06:28:45.506414Z 0 [System] [MY-010116] [Server] /usr/sbin/mysqld (mysqld 8.2.0) starting as process 1
cattr-db-1  | 2023-11-10T06:28:45.524336Z 1 [System] [MY-013576] [InnoDB] InnoDB initialization has started.
cattr-db-1  | 2023-11-10T06:28:45.779546Z 1 [System] [MY-013577] [InnoDB] InnoDB initialization has ended.
cattr-db-1  | 2023-11-10T06:28:46.137386Z 0 [Warning] [MY-010068] [Server] CA certificate ca.pem is self signed.
cattr-db-1  | 2023-11-10T06:28:46.137430Z 0 [System] [MY-013602] [Server] Channel mysql_main configured to support TLS. Encrypted connections are now supported for this channel.
cattr-db-1  | 2023-11-10T06:28:46.145928Z 0 [Warning] [MY-011810] [Server] Insecure configuration for --pid-file: Location '/var/run/mysqld' in the path is accessible to all OS users. Consider choosing a different directory.
cattr-db-1  | 2023-11-10T06:28:46.177091Z 0 [System] [MY-011323] [Server] X Plugin ready for connections. Bind-address: '::' port: 33060, socket: /var/run/mysqld/mysqlx.sock
cattr-db-1  | 2023-11-10T06:28:46.177169Z 0 [System] [MY-010931] [Server] /usr/sbin/mysqld: ready for connections. Version: '8.2.0'  socket: '/var/run/mysqld/mysqld.sock'  port: 3306  MySQL Community Server - GPL.
cattr-app-1  | s6-rc: info: service s6rc-oneshot-runner: starting
cattr-app-1  | s6-rc: info: service s6rc-oneshot-runner successfully started
cattr-app-1  | s6-rc: info: service fix-attrs: starting
cattr-app-1  | s6-rc: info: service fix-attrs successfully started
cattr-app-1  | s6-rc: info: service legacy-cont-init: starting
cattr-app-1  | s6-rc: info: service legacy-cont-init successfully started
cattr-app-1  | s6-rc: info: service prepare-filesystem: starting
cattr-app-1  | s6-rc: info: service supercronic: starting
cattr-app-1  | s6-rc: info: service supercronic successfully started
cattr-app-1  | s6-rc: info: service prepare-filesystem successfully started
cattr-app-1  | s6-rc: info: service prepare-cache: starting
cattr-app-1  | s6-rc: info: service nginx: starting
cattr-app-1  | s6-rc: info: service nginx successfully started
cattr-app-1  | time="2023-11-10T06:29:15Z" level=info msg="read crontab: /crontab"
cattr-app-1  |
cattr-app-1  |    INFO  Configuration cached successfully.
cattr-app-1  |
cattr-app-1  | s6-rc: info: service prepare-cache successfully started
cattr-app-1  | s6-rc: info: service prepare-database: starting
cattr-app-1  |
cattr-app-1  |    INFO  Running migrations.
cattr-app-1  |
cattr-app-1  |   2021_01_08_113525_create_projects_statuses_table .................. 6ms FAIL
cattr-app-1  |
cattr-app-1  | In Connection.php line 793:
cattr-app-1  |
cattr-app-1  |   SQLSTATE[42S01]: Base table or view already exists: 1050 Table 'projects_st
cattr-app-1  |   atuses' already exists (Connection: mysql, SQL: create table `projects_stat
cattr-app-1  |   uses` (`project_id` int unsigned not null, `status_id` bigint unsigned not
cattr-app-1  |   null, `color` varchar(255) null, `created_at` timestamp null, `updated_at`
cattr-app-1  |   timestamp null) default character set utf8mb4 collate 'utf8mb4_unicode_ci')
cattr-app-1  |
cattr-app-1  |
cattr-app-1  | In Connection.php line 578:
cattr-app-1  |
cattr-app-1  |   SQLSTATE[42S01]: Base table or view already exists: 1050 Table 'projects_st
cattr-app-1  |   atuses' already exists
cattr-app-1  |
cattr-app-1  |
cattr-app-1  | s6-rc: warning: unable to start service prepare-database: command exited 1
cattr-app-1  | time="2023-11-10T06:30:00Z" level=info msg=starting iteration=0 job.command="php82 /app/artisan schedule:run" job.position=0 job.schedule="* * * * *"
cattr-app-1  | time="2023-11-10T06:30:00Z" level=info channel=stdout iteration=0 job.command="php82 /app/artisan schedule:run" job.position=0 job.schedule="* * * * *"
cattr-app-1  | time="2023-11-10T06:30:00Z" level=info msg="  2023-11-10 06:30:00 Running ['artisan' gitlab:sync] ............. 232ms DONE" channel=stdout iteration=0 job.command="php82 /app/artisan schedule:run" job.position=0 job.schedule="* * * * *"
cattr-app-1  | time="2023-11-10T06:30:00Z" level=info msg="  ⇂ Synchronize projects from Gitlab for all users, who activate the Gitlab integration  " channel=stdout iteration=0 job.command="php82 /app/artisan schedule:run" job.position=0 job.schedule="* * * * *"
cattr-app-1  | time="2023-11-10T06:30:00Z" level=info msg="  2023-11-10 06:30:00 Running [Callback] ............................ 9ms DONE" channel=stdout iteration=0 job.command="php82 /app/artisan schedule:run" job.position=0 job.schedule="* * * * *"
cattr-app-1  | time="2023-11-10T06:30:00Z" level=info channel=stdout iteration=0 job.command="php82 /app/artisan schedule:run" job.position=0 job.schedule="* * * * *"
cattr-app-1  | time="2023-11-10T06:30:00Z" level=info msg="job succeeded" iteration=0 job.command="php82 /app/artisan schedule:run" job.position=0 job.schedule="* * * * *"

[vermorag]

Try to clear your database folder and run again. It seems, that migrations partially have been applied and partially not.

[sepsol]

I deleted both the data and storage directories but still had no luck. Here are the outputs:

$ docker compose up -d

[+] Running 2/2
 ✔ Container cattr-db-1   Created                                                                                  0.0s
 ✔ Container cattr-app-1  Created                                                                                  0.1s
Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: error during container init: error mounting "/run/desktop/mnt/host/wsl/docker-desktop-bind-mounts/Ubuntu/f8d7754e0b55d0549ced6c748b5770a310252fec17f823485f6ada608f1869a4" to rootfs at "/var/lib/mysql": mount /run/desktop/mnt/host/wsl/docker-desktop-bind-mounts/Ubuntu/f8d7754e0b55d0549ced6c748b5770a310252fec17f823485f6ada608f1869a4:/var/lib/mysql (via /proc/self/fd/9), flags: 0x5000: no such file or directory: unknown

$ docker compose logs

cattr-db-1  | 2023-11-10 06:28:44+00:00 [Note] [Entrypoint]: Entrypoint script for MySQL Server 8.2.0-1.el8 started.
cattr-db-1  | 2023-11-10 06:28:45+00:00 [Note] [Entrypoint]: Switching to dedicated user 'mysql'
cattr-db-1  | 2023-11-10 06:28:45+00:00 [Note] [Entrypoint]: Entrypoint script for MySQL Server 8.2.0-1.el8 started.
cattr-db-1  | '/var/lib/mysql/mysql.sock' -> '/var/run/mysqld/mysqld.sock'
cattr-db-1  | 2023-11-10T06:28:45.277108Z 0 [System] [MY-015015] [Server] MySQL Server - start.
cattr-db-1  | 2023-11-10T06:28:45.502457Z 0 [Warning] [MY-011068] [Server] The syntax '--skip-host-cache' is deprecated and will be removed in a future release. Please use SET GLOBAL host_cache_size=0 instead.
cattr-db-1  | 2023-11-10T06:28:45.506414Z 0 [System] [MY-010116] [Server] /usr/sbin/mysqld (mysqld 8.2.0) starting as process 1
cattr-db-1  | 2023-11-10T06:28:45.524336Z 1 [System] [MY-013576] [InnoDB] InnoDB initialization has started.
cattr-db-1  | 2023-11-10T06:28:45.779546Z 1 [System] [MY-013577] [InnoDB] InnoDB initialization has ended.
cattr-db-1  | 2023-11-10T06:28:46.137386Z 0 [Warning] [MY-010068] [Server] CA certificate ca.pem is self signed.
cattr-db-1  | 2023-11-10T06:28:46.137430Z 0 [System] [MY-013602] [Server] Channel mysql_main configured to support TLS. Encrypted connections are now supported for this channel.
cattr-db-1  | 2023-11-10T06:28:46.145928Z 0 [Warning] [MY-011810] [Server] Insecure configuration for --pid-file: Location '/var/run/mysqld' in the path is accessible to all OS users. Consider choosing a different directory.
cattr-db-1  | 2023-11-10T06:28:46.177091Z 0 [System] [MY-011323] [Server] X Plugin ready for connections. Bind-address: '::' port: 33060, socket: /var/run/mysqld/mysqlx.sock
cattr-db-1  | 2023-11-10T06:28:46.177169Z 0 [System] [MY-010931] [Server] /usr/sbin/mysqld: ready for connections. Version: '8.2.0'  socket: '/var/run/mysqld/mysqld.sock'  port: 3306  MySQL Community Server - GPL.
cattr-db-1  | 2023-11-10T06:35:44.057508Z 0 [System] [MY-013172] [Server] Received SHUTDOWN from user <via user signal>. Shutting down mysqld (Version: 8.2.0).
cattr-db-1  | 2023-11-10T06:35:45.329706Z 0 [System] [MY-010910] [Server] /usr/sbin/mysqld: Shutdown complete (mysqld 8.2.0)  MySQL Community Server - GPL.
cattr-db-1  | 2023-11-10T06:35:45.331425Z 0 [System] [MY-015016] [Server] MySQL Server - end.

$ docker compose ps

NAME      IMAGE     COMMAND   SERVICE   CREATED   STATUS    PORTS

$ which docker

/usr/bin/docker

[sepsol]

My bad, I tried opening the backend, because towards the end of docker logs, there was this message:

04-app-1  |    INFO  Server running…
04-app-1  |
04-app-1  |   Local: http://127.0.0.1:8090
04-app-1  |
04-app-1  |   Press Ctrl+C to stop the server

So I thought I have to open http://localhost:8090, but after paying more attention, I noticed that this is the URL for the backend server. Therefore I looked again in my docker-compose.yml file and tried the port mapping specified there (http://localhost:8080) and the frontend loaded without any problems.