Skip to content

Documentation for self-hosting with docker compose #855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

unteem
Copy link

@unteem unteem commented Apr 7, 2025

Purpose

Make self hosting of Docs easier with an example of a deployment procedure with docker compose and document how to configure Docs.

While #583 propose an easy way to deploy Docs with docker and Make, here we describe more in details the various steps and requirements to deploy Docs.

Proposal

  • example to deploy and configure keycloak
  • example to deploy and configure minio
  • example to configure proxy and certs
  • example to deploy and configure Docs

Improvements

  • Rephrase description of environment variables and categorize
  • Use template for nginx conf

Fixes #561
Supersedes #583

A one liner quick start could be a nice addition:

  • merge all services in a single compose
  • scripts to generate secrets

Sorry, something went wrong.

@unteem unteem force-pushed the documentation-docker branch 2 times, most recently from 48a9bc4 to ae27df7 Compare April 8, 2025 06:37
unteem added 3 commits April 8, 2025 10:49

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Signed-off-by: unteem <[email protected]>
Signed-off-by: unteem <[email protected]>
@unteem unteem force-pushed the documentation-docker branch from ae27df7 to 3531bf4 Compare April 8, 2025 08:50

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@AntoLC AntoLC requested a review from lunika April 8, 2025 19:23
docker compose pull
```

### Step 3: Restart yout containers
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yout

Comment on lines +67 to +79
location /collaboration-auth {
proxy_pass http://docs_backend/api/v1.0/documents/collaboration-auth/;
proxy_set_header X-Forwarded-Proto https;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Original-URL $request_uri;

# Prevent the body from being passed
proxy_pass_request_body off;
proxy_set_header Content-Length "";
proxy_set_header X-Original-Method $request_method;
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't need this anymore as mentioned here. I am not sure if we still need /media-auth or not. I've managed to spin up docs with traefik without these two /collaboration-auth and /media-auth with socket connection and real time collaboration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docker compose up production configuration
3 participants