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.

Sign up for GitHub

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
Closed

Improved Doc for docker-compose and secrets #829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,22 @@ host system for storage, pass `-v/host-path:/data`.

</details>

### Docker Compose

**1. Configure the default secrets as environment variables**

```yaml
environment:
RGW_DEFAULT_USER_ACCESS_KEY: "test"
RGW_DEFAULT_USER_SECRET_KEY: "test"
```

**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.

```

## Documentation

You can access our documentation [here][docs-link].
Expand Down
16 changes: 1 addition & 15 deletions docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ services:
s3gw:
image: quay.io/s3gw/s3gw:latest
restart: always
command:
- "--rgw-backend-store"
- "sfs"
ports:
- "7480:7480"
environment:
Expand All @@ -24,18 +21,7 @@ services:
ports:
- "8080:8080"
environment:
RGW_SERVICE_URL: "http://localhost:3080"

proxy:
image: docker.io/nginx:latest
restart: always
depends_on:
- s3gw-ui
ports:
- "80:80"
- "3080:3080"
volumes:
- ./nginx.conf:/etc/nginx/conf.d/default.conf:ro
S3GW_SERVICE_URL: "http://s3gw:7480"

volumes:
data:
35 changes: 0 additions & 35 deletions nginx.conf
View file
Open in desktop

This file was deleted.

Loading