Docmost

An open-source collaborative wiki and documentation software.

Accessing Docmost

  1. Open your web browser and navigate to: https://<SERVER_IP>
  2. Follow the Docmost setup page which will enable you set up your workspace and account.
  3. After a successful setup, you will become the workspace owner. You can then invite other users to join your workspace.
  4. For health check, a dedicated endpoint is available at https://<SERVER_IP>/api/health.

Important Files & Directories

  • Application directory: /root/docmost
  • Environment variables: /root/docmost/.env
  • Docker Compose file: /root/docmost/docker-compose.yaml
  • Nginx configuration: /etc/nginx/sites-available/docmost.conf
  • Self-signed SSL certificate: /etc/nginx/ssl/
  • Persistent data: /var/lib/docker/volumes/ (docmost_db_data/, docmost_docmost/, docmost_redis_data/)

Upgrading Docmost

To upgrade to the latest Docmost version, run the following commands:

cd /root/docmost
docker pull docmost/docmost:latest
docker compose up --force-recreate --build docmost -d

Managing Docmost

Check running services:

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

View logs:

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

Restart Docmost containers:

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

Restart Nginx:

systemctl restart nginx

Enabling SSL with a Domain

1. Point your domain to the server IP.

2. Edit the /root/docmost/.env file to set your domain name: APP_URL=https://your.domain.com

3. Recreate the services:

cd /root/docmost/
docker compose up -d

4. Edit Nginx config and replace both server_name <IP>; with your domain (<your-domain>) for both HTTP (port 80) and HTTPS (port 443) blocks:

vim /etc/nginx/sites-available/docmost.conf

5. Install Certbot:

apt install -y certbot python3-certbot-nginx

6. Run the following command to generate a valid Let’s Encrypt certificate:

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

7. Replace SSL paths in Nginx config (TLS section):

vim /etc/nginx/sites-available/docmost.conf
# Before:
    # ssl_certificate /etc/nginx/ssl/fullchain.pem;
    # ssl_certificate_key /etc/nginx/ssl/privkey.pem;
# After:
    # ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
    # ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;

8. Restart Nginx to apply the changes:

systemctl restart nginx

9. Open your browser and visit: https://yourdomain.com

Application Details