Create README.md

This commit is contained in:
Aykhan Shahsuvarov 2024-12-13 17:03:33 +04:00 committed by GitHub
parent e667b8b133
commit cacded8fbf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

41
README.md Normal file
View File

@ -0,0 +1,41 @@
## Prerequisites
- **Bash**
- **Docker**
- **Docker compose**
## Getting Started
Follow these steps to set up and start the services:
### 1. Grant Execute Permissions
Ensure the `main.sh` script has the necessary permissions:
```sh
chmod +x main.sh
```
### 2. Generate Environment Files
Create `.env` configuration files with the following command:
```sh
./main.sh generate-env
```
### 3. Configure Environment Variables
Edit the generated `.env` files to fill in the required fields:
- `./gitea/.env`
- `./searxng/.env`
- `./sftpgo/.env`
- `./vaultwarden/.env`
- `./wg_easy/.env`
- `./caddy/.env`
### 4. Start Services
Launch all services with the following command:
```sh
./main.sh start
```
## Stopping Services
To stop all running services, use:
```sh
./main.sh stop
```