Installation Guide

System Requirements

  • Docker and Docker Compose
  • Minimum 4GB RAM
  • 20GB disk space
  • Ubuntu 20.04 LTS or similar

Quick Install

1. Clone the Repository

git clone https://github.com/your-org/docshub.git
cd docshub

2. Configure Environment

cp .env.example .env.production
# Edit .env.production with your settings

3. Start Services

docker-compose --profile with-proxy up -d

4. Access DocsHub

https://your-instance.com

Configuration

Environment Variables

# External Host
EXTERNAL_HOST=docshub.example.com
EXTERNAL_PORT=443
EXTERNAL_PROTOCOL=https

# Database
DB_PASSWORD=secure_password_here

# Keycloak Admin
KEYCLOAK_ADMIN_PASSWORD=secure_password_here

# OIDC
OIDC_ISSUER_URI=https://docshub.example.com/realms/docshub

Verification

Check that all services are running:

docker-compose ps

You should see all services healthy.

Troubleshooting

Port Already in Use

  • Check and stop conflicting processes

Database Connection Issues

  • Review database logs
  • Check credentials

SSL Certificate Errors

  • Use self-signed certificates during development
  • Install proper certificates for production
Did you find this content useful ?