Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lennetech/deploy.party
deploy.party is a simple and easy-to-use deployment tool for your applications.
https://github.com/lennetech/deploy.party
automation cd ci container dark-theme deploy deployment docker party traefik
Last synced: 18 days ago
JSON representation
deploy.party is a simple and easy-to-use deployment tool for your applications.
- Host: GitHub
- URL: https://github.com/lennetech/deploy.party
- Owner: lenneTech
- License: mit
- Created: 2024-12-18T11:31:32.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2024-12-19T15:45:22.000Z (21 days ago)
- Last Synced: 2024-12-19T15:48:05.272Z (21 days ago)
- Topics: automation, cd, ci, container, dark-theme, deploy, deployment, docker, party, traefik
- Language: TypeScript
- Homepage: https://lenne.tech
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# deploy.party - quick deploy, party enjoy!
deploy.party is a simple and easy-to-use deployment tool for your applications.
## Features
- 🎉 Deploy any application with a simple UI
- 🎉 Deploy directly from GitLab or GitHub
- 🎉 Deploy docker image to local registry or other registries
- 🎉 Start databases with a single click (MongoDB, MariaDB)
- 🎉 Create custom containers with custom docker-compose and Dockerfile
- 🎉 Split your containers into projects
- 🎉 Automatic SSL and www-redirect
- 🎉 Simple backups to S3 compatible storage
- 🎉 Integrated terminal for direct access to the container _beta_
- 🎉 See logs of your containers
- 🎉 See statistics of your containers
## Requirements
- Server access with root permissions
- **Configure DNS** with A record for `YOUR_URL` and `*.YOUR_URL` to `SERVER_IP`.
## Install
Replace follow placeholders with your values:
`SERVER_IP`: IP of the server
```bash
ssh root@SERVER_IP
```
```bash
sh -c "$(curl -fsSL https://raw.githubusercontent.com/lenneTech/deploy.party/main/install.sh)"
```
#### Install fail2ban (optional)
https://www.digitalocean.com/community/tutorials/how-to-protect-ssh-with-fail2ban-on-ubuntu-22-04
## Configuration
```bash
nano /var/opt/deploy-party/data/.env
```
After you have configured the `.env` file, you can reconfigure the deploy.party with the following command:
```bash
sh /var/opt/deploy-party/reconfigure.sh
```
## Update
```bash
sh /var/opt/deploy-party/update.sh
```
## URLs
Now Traefik UI will be available at `lb.YOUR_URL` and deploy.party at `YOUR_URL`.
Traefik has basic auth lock and can be accessed with the `USERNAME` and `PASSWORD` you set in the init.sh script.
On **local setup**:
- Deploy Party: [http://[IP]:3001](http://[IP]:3001)
- Minio UI: [http://[IP]:3004](http://[IP]:9000)
- Deploy Party API: [http://[IP]:3000](http://[IP]:3000)
- Deploy Party Terminal API: [http://[IP]:3002](http://[IP]:3002)
- Minio API: [http://[IP]:3003](http://[IP]:9001)
## First steps
Default credentails are:
`[email protected]`
`deploy-party`
**Please create a new admin account and delete the old one.**
## Usage
### Create new admin account or invite new users
1. Click on plus in topbar and create new member
2. Fill form and choose the right role
3. The invited user receives an e-mail with the request to set a password.
### Create source
1. Go to sources
2. Click on plus in topbar and create new source
3. Enter name of source for example GitLab
4. Enter the URL of the GitLab instance for example https://gitlab.com
5. Enter the personal access token for the GitLab API [GitLab Docs](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
- Create personal access token with following scopes: `api, read_api, read_registry, write_registry`
- Personal access token global (-/user_settings/personal_access_tokens) or Personal access token for project (/GROUP/PROJECT/-/settings/access_tokens)
### Create your first project
1. Click on plus in topbar and create new project
2. Enter name for project
### Create your first container
1. Click on plus in topbar and create new container
2. Select the created project
3. Enter the name of the container
4. Choose the kind of container (`APPLICATION`, `DATABASE`, `SERVICE`, `CUSTOM`)
- `APPLICATION`: A normal application
- `DATABASE`: A database
- `SERVICE`: A service like a directus, ...
- `CUSTOM`: A custom container with custom docker-compose and Dockerfile
5. Select the source
6. Enter the image name
7. Select registry
8. Enter commands
9. Enter environment variables
10. Enter ports
11. Start the container
## Helpful commands
### Restart traefik
```bash
docker stack rm traefik
```
**Wait if traefik container not shown under `docker ps`** before you run the next command.
```bash
cd /var/opt/deploy-party
```
```bash
export $(cat .env | grep -v '#' | awk '/=/ {print $1}') && docker stack deploy -c docker-compose.traefik.yml traefik
```
## Restart deploy.party
```bash
cd /var/opt/deploy-party
```
```bash
sh reconfigure.sh
```