Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flokapi/dockup
Publish multiple docker containers as a Python package and CLI tool
https://github.com/flokapi/dockup
docker nginx
Last synced: about 2 months ago
JSON representation
Publish multiple docker containers as a Python package and CLI tool
- Host: GitHub
- URL: https://github.com/flokapi/dockup
- Owner: flokapi
- License: agpl-3.0
- Created: 2023-09-19T22:47:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-27T18:51:49.000Z (over 1 year ago)
- Last Synced: 2024-10-18T21:39:03.550Z (3 months ago)
- Topics: docker, nginx
- Language: Python
- Homepage:
- Size: 26.4 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# About
Dockup is a command line interface tool and a Python package which allows to easily publish applications at a given path through docker containers and nginx.
A Dockup package is a compressed file containing:
- the content you want to publish: Python script, HTML file, ...
- the `dockup.yml` configuration file which contains the following info
- `name` of the package, must be the same name as the directory containing it
- `path` at which the package will be accessible. For example `/app1` for `website.com/app1`
- `type` of the package. For example, `website`, `flet` application
- optional: `Dockerfile` and `nginx.conf` in case customization is needed
- for Python applications only, the `requirements.txt` file
When you publish a Dockup package, the tool will do the following things automatically for you:
- Docker compose down
- Extract the package archive in the Dockup app folder
- If necessary, build the nginx configuration
- If necessary, build the docker file
- Rebuild the docker compose file
- Docker compose build and up
The nginx reverse proxy used by Dockup is also installed as Dockup package. This makes it convenient to configure and update the reverse proxy, for example to configure HTTPS on your server.
# Installation
First of all install the docker engine: https://docs.docker.com/engine/install/
Then install Dockup as a pip package
```
pip3 install dockup
```
You must install a reverse proxy package (see below) before you can publish your applications.
# Usage
### As a command line tool
Install the reverse proxy Package
- given that your reverse proxy package is located in your current working directory
- you can prepare the reverse proxy package according to you needs:
- [reverse_proxy_http](https://github.com/flokapi/dockup/tree/main/example_packages/reverse_proxy_http) is an example of simple HTTP proxy
- [reverse_proxy_https](https://github.com/flokapi/dockup/tree/main/example_packages/reverse_proxy_https) is an example of simple HTTP**S** proxy
- you can also specify the package as an archive if it is present in your working directory.
```
python3 -m dockup installproxy reverse_proxy_http
```
Publish a package
- you can also specify the package as an archive if it is present in your working directory.
```
pyhton3 -m dockup install flet_app1
```
To remove a package
```
python3 -m dockup uninstall flet_app1
```
### As a Python package
```python
import dockup
dockup.down()
dockup.reset()
dockup.set_proxy('./reverse_proxy_http.tar.gz')
dockup.add('./flet_app1.tar.gz')
dockup.add('./flet_app2.tar.gz')
dockup.up()
```