| Name | dockup JSON |
| Version |
0.0.13
JSON |
| download |
| home_page | |
| Summary | Publish multiple docker containers using nginx |
| upload_time | 2023-09-23 10:37:09 |
| maintainer | |
| docs_url | None |
| author | flokapi |
| requires_python | >=3.7,<4.0 |
| license | GPL-3.0-only |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Dockup is a command line interface tool 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 archive 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
When you publish a Dockup package, the tool will do the following things automatically for you:
- Docker compose stop
- 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
- Dockup 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
```
# Usage
### As a command line tool
Install the 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 (not configured for HTTPS)
- 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')
build_nodes()
dockup.up()
```
Raw data
{
"_id": null,
"home_page": "",
"name": "dockup",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "flokapi",
"author_email": "flokapi@pm.me",
"download_url": "https://files.pythonhosted.org/packages/f1/5c/e55747dea98af8c87d6ec182dbb2d3d5565307520baa706e045c5975ffa5/dockup-0.0.13.tar.gz",
"platform": null,
"description": "Dockup is a command line interface tool which allows to easily publish applications at a given path through docker containers and nginx.\n\nA Dockup package is a compressed file containing:\n\n- the content you want to publish: python script, HTML file, ...\n\n- the `dockup.yml` configuration file which contains the following info\n\n - `name` of the package, must be the same name as the archive containing it\n - `path` at which the package will be accessible. For example `/app1` for `website.com/app1` \n\n - `type` of the package. For example, `website`, `flet` application\n\n- optional: `Dockerfile` and `nginx.conf` in case customization is needed\n\n\n\nWhen you publish a Dockup package, the tool will do the following things automatically for you:\n\n- Docker compose stop\n- Extract the package archive in the Dockup app folder\n- If necessary, build the nginx configuration\n- If necessary, build the docker file\n- Rebuild the docker compose file\n- Dockup compose build and up\n\n\n\nThe 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.\n\n\n\n# Installation\n\nFirst of all install the docker engine: https://docs.docker.com/engine/install/\n\nThen install Dockup as a pip package\n\n```\npip3 install dockup\n```\n\n\n\n# Usage\n\n### As a command line tool\n\nInstall the proxy Package\n\n- given that your reverse proxy package is located in your current working directory\n- you can prepare the reverse proxy package according to you needs:\n - [reverse_proxy_http](https://github.com/flokapi/dockup/tree/main/example_packages/reverse_proxy_http) is an example of simple HTTP proxy (not configured for HTTPS)\n- you can also specify the package as an archive if it is present in your working directory.\n\n```\npython3 -m dockup installproxy reverse_proxy_http\n```\n\n\n\nPublish a package\n\n- you can also specify the package as an archive if it is present in your working directory.\n\n```\npyhton3 -m dockup install flet_app1\n```\n\n\n\nTo remove a package\n\n```\npython3 -m dockup uninstall flet_app1\n```\n\n\n\n### As a python package\n\n```python\nimport dockup\n\ndockup.down()\ndockup.reset()\ndockup.set_proxy('./reverse_proxy_http.tar.gz')\ndockup.add('flet_app1.tar.gz')\nbuild_nodes()\ndockup.up()\n```\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Publish multiple docker containers using nginx",
"version": "0.0.13",
"project_urls": {
"documentation": "https://github.com/flokapi/dockup",
"homepage": "https://github.com/flokapi/dockup",
"repository": "https://github.com/flokapi/dockup"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6def573a1219d995636938c31bcf4fd8f48283c1e745311f3370e1b5a8348af8",
"md5": "d7dacd3c5b9538250bc8df6149f6d0c1",
"sha256": "87f68435ddbf93601b8c156435a491e7ea793ff9108e5041721a17437a39f739"
},
"downloads": -1,
"filename": "dockup-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7dacd3c5b9538250bc8df6149f6d0c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 17986,
"upload_time": "2023-09-23T10:37:06",
"upload_time_iso_8601": "2023-09-23T10:37:06.877016Z",
"url": "https://files.pythonhosted.org/packages/6d/ef/573a1219d995636938c31bcf4fd8f48283c1e745311f3370e1b5a8348af8/dockup-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f15ce55747dea98af8c87d6ec182dbb2d3d5565307520baa706e045c5975ffa5",
"md5": "6f7005633c2c5fc61d96c5c4cbc514af",
"sha256": "b2f4f9c2b2cf7b68b83894d93909e63e0c0fb7ae16d5f64ee88315d2a35a9a17"
},
"downloads": -1,
"filename": "dockup-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "6f7005633c2c5fc61d96c5c4cbc514af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 16173,
"upload_time": "2023-09-23T10:37:09",
"upload_time_iso_8601": "2023-09-23T10:37:09.068596Z",
"url": "https://files.pythonhosted.org/packages/f1/5c/e55747dea98af8c87d6ec182dbb2d3d5565307520baa706e045c5975ffa5/dockup-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-23 10:37:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flokapi",
"github_project": "dockup",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dockup"
}
