Gokapi

Access

• Open your browser: https://<SERVER_IP>/
• Self-signed SSL certificate is used, so a browser warning is expected on first visit.

First Setup

1. Open the setup page: https://<SERVER_IP>/setup
2. Follow the setup wizard to configure your instance
3. This will generate a config.json inside the config directory

Setup Notes

• For a quick setup, select SQLite as the database during the setup wizard. Redis is not installed by default. If needed, install and configure it manually.
• For Use SSL (a self-signed certificate will be generated that can be replaced), select No. HTTPS is already provided by Nginx using a self-signed certificate.
• Set Public Facing URL to the URL users will use to access your instance. By default, it is configured as https://<SERVER_IP>/. If you later configure a domain, update this value accordingly.

Important Paths

• Install directory: /root/gokapi
• Docker Compose file: /root/gokapi/compose.yaml
• Environment file: /root/gokapi/.env
• Data storage: /root/gokapi/gokapi-data
• Configuration: /root/gokapi/gokapi-config
• Nginx config: /etc/nginx/sites-available/gokapi
• SSL certificate: /etc/nginx/ssl/gokapi.crt
• SSL key: /etc/nginx/ssl/gokapi.key

Docker Management

View running containers:

docker compose -f /root/gokapi/compose.yaml ps

Restart all containers:

docker compose -f /root/gokapi/compose.yaml restart

Follow application logs:

docker compose -f /root/gokapi/compose.yaml logs -f

Stop the application:

docker compose -f /root/gokapi/compose.yaml down

Start the application:

docker compose -f /root/gokapi/compose.yaml up -d

Managing Nginx

Check status:

systemctl status nginx

Restart Nginx:

systemctl restart nginx

Reload Nginx:

systemctl reload nginx

Validate the configuration:

nginx -t