From ac0922d742d5cbf5f7a9d1a776ffb892b359e727 Mon Sep 17 00:00:00 2001 From: Zakher Masri Date: Tue, 11 Mar 2025 14:38:37 +0300 Subject: [PATCH 1/3] docs: update `CONTRIBUTING.md` and add `GUIDES.md` --- CONTRIBUTING.md | 5 +- GUIDES.md | 140 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 143 insertions(+), 2 deletions(-) create mode 100644 GUIDES.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c64d0672e..0042bafde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,9 +61,10 @@ pnpm install cp apps/dokploy/.env.example apps/dokploy/.env ``` -## Development +## Requirements -Is required to have **Docker** installed on your machine. +- [Docker](/GUIDES.md#docker) +- [Radis](/GUIDES.md#redis) ### Setup diff --git a/GUIDES.md b/GUIDES.md new file mode 100644 index 000000000..59f929bd3 --- /dev/null +++ b/GUIDES.md @@ -0,0 +1,140 @@ +# Docker + +Here's how to install docker on different operating systems: + +## macOS + +1. Visit [Docker Desktop for Mac](https://www.docker.com/products/docker-desktop) +2. Download the Docker Desktop installer +3. Double-click the downloaded `.dmg` file +4. Drag Docker to your Applications folder +5. Open Docker Desktop from Applications +6. Follow the onboarding tutorial if desired + +## Linux + +### Ubuntu + +```bash +# Update package index +sudo apt-get update + +# Install prerequisites +sudo apt-get install \ + apt-transport-https \ + ca-certificates \ + curl \ + gnupg \ + lsb-release + +# Add Docker's official GPG key +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg + +# Set up stable repository +echo \ + "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null + +# Install Docker Engine +sudo apt-get update +sudo apt-get install docker-ce docker-ce-cli containerd.io +``` + +## Windows + +1. Enable WSL2 if not already enabled +2. Visit [Docker Desktop for Windows](https://www.docker.com/products/docker-desktop) +3. Download the installer +4. Run the installer and follow the prompts +5. Start Docker Desktop from the Start menu + +# Redis + +## Installation + +### macOS + +```bash +brew install redis +``` + +### Ubuntu + +```bash +sudo apt-get update +sudo apt-get install redis-server +``` + +### Windows + +1. Download the Redis Windows Subsystem for Linux (WSL) package +2. Follow WSL installation instructions +3. Install Redis through WSL using Ubuntu instructions + +## Start Redis Server + +### macOS and Linux + +```bash +# Start Redis server +redis-server + +# To start Redis in the background +redis-server --daemonize yes + +# To stop Redis server +redis-cli shutdown +``` + +### Using Docker + +```bash +# Pull Redis image +docker pull redis + +# Run Redis container +docker run --name my-redis -d -p 6379:6379 redis + +# Connect to Redis CLI +docker exec -it my-redis redis-cli +``` + +## Testing Redis Connection + +```bash +# Connect to Redis CLI +redis-cli + +# Test connection +ping +# Should respond with "PONG" + +# Set and get a test value +set test "Hello Redis" +get test +``` + +## Common Redis Commands + +```bash +# Set a key +SET key value + +# Get a value +GET key + +# Delete a key +DEL key + +# Check if key exists +EXISTS key + +# Set expiration (in seconds) +EXPIRE key seconds + +# List all keys +KEYS * + +# Get key type +TYPE key +``` From bc781006131239cb6b710e27b43534dab3c82274 Mon Sep 17 00:00:00 2001 From: Zakher Masri Date: Tue, 18 Mar 2025 12:02:03 +0300 Subject: [PATCH 2/3] remove redis part --- GUIDES.md | 93 +------------------------------------------------------ 1 file changed, 1 insertion(+), 92 deletions(-) diff --git a/GUIDES.md b/GUIDES.md index 59f929bd3..cfb7cd812 100644 --- a/GUIDES.md +++ b/GUIDES.md @@ -46,95 +46,4 @@ sudo apt-get install docker-ce docker-ce-cli containerd.io 2. Visit [Docker Desktop for Windows](https://www.docker.com/products/docker-desktop) 3. Download the installer 4. Run the installer and follow the prompts -5. Start Docker Desktop from the Start menu - -# Redis - -## Installation - -### macOS - -```bash -brew install redis -``` - -### Ubuntu - -```bash -sudo apt-get update -sudo apt-get install redis-server -``` - -### Windows - -1. Download the Redis Windows Subsystem for Linux (WSL) package -2. Follow WSL installation instructions -3. Install Redis through WSL using Ubuntu instructions - -## Start Redis Server - -### macOS and Linux - -```bash -# Start Redis server -redis-server - -# To start Redis in the background -redis-server --daemonize yes - -# To stop Redis server -redis-cli shutdown -``` - -### Using Docker - -```bash -# Pull Redis image -docker pull redis - -# Run Redis container -docker run --name my-redis -d -p 6379:6379 redis - -# Connect to Redis CLI -docker exec -it my-redis redis-cli -``` - -## Testing Redis Connection - -```bash -# Connect to Redis CLI -redis-cli - -# Test connection -ping -# Should respond with "PONG" - -# Set and get a test value -set test "Hello Redis" -get test -``` - -## Common Redis Commands - -```bash -# Set a key -SET key value - -# Get a value -GET key - -# Delete a key -DEL key - -# Check if key exists -EXISTS key - -# Set expiration (in seconds) -EXPIRE key seconds - -# List all keys -KEYS * - -# Get key type -TYPE key -``` +5. Start Docker Desktop from the Start menu \ No newline at end of file From a431e4c58e6ed4cbe9810df2a1fa127c2845470c Mon Sep 17 00:00:00 2001 From: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com> Date: Sat, 29 Mar 2025 14:28:11 -0600 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0042bafde..015095aa6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,6 @@ cp apps/dokploy/.env.example apps/dokploy/.env ## Requirements - [Docker](/GUIDES.md#docker) -- [Radis](/GUIDES.md#redis) ### Setup