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 2 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

@unteem unteem force-pushed the documentation-docker branch 3 times, most recently from ae27df7 to 3531bf4 Compare April 8, 2025 08:50
@AntoLC AntoLC requested a review from lunika April 8, 2025 19:23
Copy link
Member

@lunika lunika left a comment

Choose a reason for hiding this comment

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

you commits does not have a description. It is useful to add it to explain why you made the modification about the env.md file for example.

@mustafa0x
Copy link

This commit will make docs more accessible to a huge number of teams. Eagerly waiting to see it committed!

@unteem unteem force-pushed the documentation-docker branch 2 times, most recently from 94046a7 to 99bd17d Compare May 20, 2025 13:13
@unteem
Copy link
Author

unteem commented May 20, 2025

Thanks for the reviews, should be good now.

@lunika I removed the commits that change env.md and will make another PR of those changes make sense. I think its better to split it.

@virgile-dev virgile-dev requested review from qbey and lunika May 20, 2025 15:10
@unteem unteem force-pushed the documentation-docker branch from 99bd17d to b5cd3e7 Compare May 21, 2025 09:05
Copy link
Collaborator

@virgile-dev virgile-dev left a comment

Choose a reason for hiding this comment

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

How about we keep an installation.md at the root of the /docs folder where we can list the different deployment option (K8S, Compose and NIX) ?

Copy link
Collaborator

@virgile-dev virgile-dev left a comment

Choose a reason for hiding this comment

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

Let's merge this and make documentation for different deployment solution more homogeneous in a next PR.

@virgile-dev virgile-dev removed the request for review from qbey May 23, 2025 09:17
@virgile-dev virgile-dev enabled auto-merge (squash) May 23, 2025 09:19
auto-merge was automatically disabled May 23, 2025 10:41

Head branch was pushed to by a user without write access

@unteem unteem force-pushed the documentation-docker branch 6 times, most recently from 637e3f7 to 072463a Compare May 23, 2025 13:05
@unteem unteem force-pushed the documentation-docker branch from 072463a to b178c35 Compare May 23, 2025 13:09
@virgile-dev virgile-dev enabled auto-merge (squash) May 23, 2025 20:02
@virgile-dev
Copy link
Collaborator

@unteem can you make the last test pass so we can merge this please ?

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
7 participants