Skip to content

Commit 6968cb6

Browse files
authored
Merge pull request #1465 from zaaakher/docs/guides
docs: update `CONTRIBUTING.md` and add `GUIDES.md`
2 parents c5b4b85 + a431e4c commit 6968cb6

File tree

2 files changed

+51
-2
lines changed

2 files changed

+51
-2
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ pnpm install
6161
cp apps/dokploy/.env.example apps/dokploy/.env
6262
```
6363

64-
## Development
64+
## Requirements
6565

66-
Is required to have **Docker** installed on your machine.
66+
- [Docker](/GUIDES.md#docker)
6767

6868
### Setup
6969

GUIDES.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Docker
2+
3+
Here's how to install docker on different operating systems:
4+
5+
## macOS
6+
7+
1. Visit [Docker Desktop for Mac](https://www.docker.com/products/docker-desktop)
8+
2. Download the Docker Desktop installer
9+
3. Double-click the downloaded `.dmg` file
10+
4. Drag Docker to your Applications folder
11+
5. Open Docker Desktop from Applications
12+
6. Follow the onboarding tutorial if desired
13+
14+
## Linux
15+
16+
### Ubuntu
17+
18+
```bash
19+
# Update package index
20+
sudo apt-get update
21+
22+
# Install prerequisites
23+
sudo apt-get install \
24+
apt-transport-https \
25+
ca-certificates \
26+
curl \
27+
gnupg \
28+
lsb-release
29+
30+
# Add Docker's official GPG key
31+
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
32+
33+
# Set up stable repository
34+
echo \
35+
"deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
36+
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
37+
38+
# Install Docker Engine
39+
sudo apt-get update
40+
sudo apt-get install docker-ce docker-ce-cli containerd.io
41+
```
42+
43+
## Windows
44+
45+
1. Enable WSL2 if not already enabled
46+
2. Visit [Docker Desktop for Windows](https://www.docker.com/products/docker-desktop)
47+
3. Download the installer
48+
4. Run the installer and follow the prompts
49+
5. Start Docker Desktop from the Start menu

0 commit comments

Comments
 (0)