Skip to content

Docker compose public availability#190

Merged
Svanvith merged 16 commits intomainfrom
docker-compose-public-availability
Mar 31, 2025
Merged

Docker compose public availability#190
Svanvith merged 16 commits intomainfrom
docker-compose-public-availability

Conversation

@Svanvith
Copy link
Copy Markdown
Contributor

No description provided.

---

# Docker Compose
# **Docker Compose Installation Guide**
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The wording installation is misleading, users could get the impression, this is a guide to install docker compose

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

changed now.

Copy link
Copy Markdown
Member

@fschade fschade left a comment

Choose a reason for hiding this comment

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

some findings... nothing crucial and if you ask me optional, up do you! Thanks, good contribution!

Comment thread docs/admin/20-getting-started/20-docker-compose.md Outdated
Comment thread docs/admin/20-getting-started/20-docker-compose.md
Comment thread docs/admin/20-getting-started/20-docker-compose.md

## **Prerequisites:**
- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)
- [**Git**](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

not necessarily, the file can be downloaded from GH too...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I will let it in, because we need sometimes to install it before. Only to be safe ;)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think it is a bit of overkill to clone the whole repo just for the dir. Maybe we need another "quick script" that people can call like wget https://opencloud.eu/docker-composition or so...
Out of scope of this PR tough

Comment thread docs/admin/20-getting-started/25-docker-compose-local.md
@Svanvith Svanvith requested a review from AlexAndBear March 28, 2025 11:39
Comment thread docs/admin/20-getting-started/20-docker-compose.md Outdated
Comment thread docs/admin/20-getting-started/20-docker-compose.md Outdated
Comment thread docs/admin/20-getting-started/20-docker-compose.md Outdated

### 1. Download

Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration):
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

That's misleading, you speak about download the folder but next step you are cloning the whole repo

Copy link
Copy Markdown
Member

@dragotin dragotin left a comment

Choose a reason for hiding this comment

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

Nice...


```bash
apt update && apt upgrade -y
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This does not only update the package list (that is apt update, but updates the entire system. Nothing wrong with that.
However, I would still not write it that detailed. The entire article is distro agnostic, but this is a debian/ubuntu only command, so I would rather recommend something like Make sure your system packages are updated according to your base system. or so.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

we can add for other distro the commands in a separate tab.
But I think we need a decision if we only should describe ubuntu or other distro too. If only Ubuntu you are right, we need to write it.

```bash
apt update && apt upgrade -y
```
Install Docker following the [official Docker guide](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Again a reference to Ubuntu. Either it is targeted at Ubuntu, than we should change the Prerequisite above saying that, or we keep it distro agnostic.

You should see a security warning because the staging certificate is not fully trusted.
Same should appear with the other domains you are using.

Example with Chrome browser:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nitpicking: We promote open source - which Chrome is not particularly. Maybe consider using Firefox for these kind of things.

nano .env
```

Comment out the staging server:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think in English you can drop the "out" ...


## **Prerequisites:**
- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)
- [**Git**](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think it is a bit of overkill to clone the whole repo just for the dir. Maybe we need another "quick script" that people can call like wget https://opencloud.eu/docker-composition or so...
Out of scope of this PR tough


### Troubleshooting

If you encounter any issues or errors, try finding a solution here:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
If you encounter any issues or errors, try finding a solution here:
If you encounter any issues or errors, you will find a solution here:

@Svanvith
Copy link
Copy Markdown
Contributor Author

@dragotin I made some changes according to your suggestions.

@Svanvith Svanvith merged commit fb43e65 into main Mar 31, 2025
1 check passed
@Svanvith Svanvith deleted the docker-compose-public-availability branch March 31, 2025 15:04
@openclouders openclouders mentioned this pull request Mar 31, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants