Skip to content
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

Improved Doc for docker-compose and secrets #829

Closed
wants to merge 1 commit into from

Conversation

filopedraz
Copy link

Description

  • Improved doc to include docker-compose
  • Included reference on how to set default secrets
  • Fixed docker-compose and removed proxy.

Signed-off-by: Filippo Pedrazzini <[email protected]>
@jecluis jecluis requested review from m-ildefons and votdev November 22, 2023 03:37
@jecluis jecluis linked an issue Nov 22, 2023 that may be closed by this pull request
@jecluis jecluis added kind/bug Something isn't working kind/documentation Improvements or additions to documentation priority/1 Should be fixed for next release labels Nov 22, 2023
Copy link
Contributor

@votdev votdev left a comment

Choose a reason for hiding this comment

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

There are some markdown lint errors:

README.md:76 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "1. Configure the default secre..."]
README.md:84 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "2. Run docker-compose"]

**2. Run docker-compose**

```bash
docker-compose up -d
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this correct, i need to use docker compose up -d?

Copy link
Contributor

Choose a reason for hiding this comment

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

-d detaches the process from the shell (aka. daemonizes the process), so you'll be dropped back to your shell while the docker-compose process continues in the background. This allows you to log out of the machine without killing the process or run other continue using the shell with other commands. It's entirely optional.
You can use docker-compose down to stop the containers later on.

Copy link
Contributor

Choose a reason for hiding this comment

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

What i mean is docker-compose vs docker compose. On my Ubuntu installation i get

$ which docker-compose                         
docker-compose not found

Regarding the -d. I prefer to not mention it in the docs because running it in front helps to watch what is going on. User that want to run it in background can simply add the -d on their own.

@jecluis
Copy link
Contributor

jecluis commented Apr 1, 2024

We're planning on reworking the docker-compose file soon-ish. We appreciate the contribution, but at this time we'll wait for the incoming rework of this file. Thanks!

@jecluis jecluis closed this Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Something isn't working kind/documentation Improvements or additions to documentation priority/1 Should be fixed for next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The docker-compose.yaml file is incorrect
4 participants