<br>
<h1 align="center">
<a href="https://github.com/raymond-u/lungo">
<img src="https://github.com/raymond-u/lungo/assets/36328498/5a8a3696-61c1-46cc-a1b4-144141da2d36" alt="Lungo" width="120">
</a>
<br>
<b>Lungo</b>
<br>
</h1>
<p align="center">
A user-friendly home lab setup designed for small-to-mid-scale on-premises hosting.
<br>
</p>
<p align="center">
<a href="https://pypi.org/project/lungo-cli/" style="text-decoration: none">
<img src="https://badge.fury.io/py/lungo-cli.svg" alt="PyPI version">
</a>
<a href="https://opensource.org/licenses/MIT" style="text-decoration: none">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT">
</a>
</p>
<br>
## Features
- **Complete configurability** - manage everything declaratively through YAML files
- **Seamless interoperability** - access all applications via a single sign-on portal
- **Batteries included** - extend functionality with both built-in and custom plugins
- **Containerized solution** - designed to operate in a rootless Docker environment
- **Security by default** - use HTTPS and secure server settings across the system
## Installation
The recommended way to install Lungo is via [pipx](https://pypa.github.io/pipx/):
```bash
pipx install lungo-cli
```
Note that Lungo is built upon [Docker Compose](https://github.com/docker/compose). Before proceeding, please ensure that
Docker is installed on your machine.
Alternatively, you can use [Podman Compose](https://github.com/containers/podman-compose)
with [Podman](https://podman.io/). You can
also [use Docker Compose with Podman](https://fedoramagazine.org/use-docker-compose-with-podman-to-orchestrate-containers-on-fedora/).
For instructions on setting up these tools, please refer to their respective documentation.
## Quickstart
Copy the example configuration files to the platform-specific configuration directory. For example, on Linux, you can
use the following command:
```bash
mkdir -p ~/.config/lungo
cp examples/* ~/.config/lungo
```
Edit the configuration files according to your preferences. Then, launch the Lungo service by running the following
command:
```bash
lungo up
```
## Documentation
For more information, please refer to the [documentation](https://raymond-u.github.io/lungo/).
## License
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/raymond-u/lungo",
"name": "lungo-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "homelab, self-host",
"author": "raymond-u",
"author_email": "36328498+raymond-u@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/f5/8a/3a6713c2da137ae469cfcba3fe7f77c20ef8294216f9fa8d8e28ec6adba6/lungo_cli-0.4.1.tar.gz",
"platform": null,
"description": "<br>\n\n<h1 align=\"center\">\n <a href=\"https://github.com/raymond-u/lungo\">\n <img src=\"https://github.com/raymond-u/lungo/assets/36328498/5a8a3696-61c1-46cc-a1b4-144141da2d36\" alt=\"Lungo\" width=\"120\">\n </a>\n <br>\n <b>Lungo</b>\n <br>\n</h1>\n\n<p align=\"center\">\n A user-friendly home lab setup designed for small-to-mid-scale on-premises hosting.\n <br>\n</p>\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/lungo-cli/\" style=\"text-decoration: none\">\n <img src=\"https://badge.fury.io/py/lungo-cli.svg\" alt=\"PyPI version\">\n </a>\n <a href=\"https://opensource.org/licenses/MIT\" style=\"text-decoration: none\">\n <img src=\"https://img.shields.io/badge/License-MIT-yellow.svg\" alt=\"License: MIT\">\n </a>\n</p>\n\n<br>\n\n## Features\n\n- **Complete configurability** - manage everything declaratively through YAML files\n- **Seamless interoperability** - access all applications via a single sign-on portal\n- **Batteries included** - extend functionality with both built-in and custom plugins\n- **Containerized solution** - designed to operate in a rootless Docker environment\n- **Security by default** - use HTTPS and secure server settings across the system\n\n## Installation\n\nThe recommended way to install Lungo is via [pipx](https://pypa.github.io/pipx/):\n\n```bash\npipx install lungo-cli\n```\n\nNote that Lungo is built upon [Docker Compose](https://github.com/docker/compose). Before proceeding, please ensure that\nDocker is installed on your machine.\n\nAlternatively, you can use [Podman Compose](https://github.com/containers/podman-compose)\nwith [Podman](https://podman.io/). You can\nalso [use Docker Compose with Podman](https://fedoramagazine.org/use-docker-compose-with-podman-to-orchestrate-containers-on-fedora/).\n\nFor instructions on setting up these tools, please refer to their respective documentation.\n\n## Quickstart\n\nCopy the example configuration files to the platform-specific configuration directory. For example, on Linux, you can\nuse the following command:\n\n```bash\nmkdir -p ~/.config/lungo\ncp examples/* ~/.config/lungo\n```\n\nEdit the configuration files according to your preferences. Then, launch the Lungo service by running the following\ncommand:\n\n```bash\nlungo up\n```\n\n## Documentation\n\nFor more information, please refer to the [documentation](https://raymond-u.github.io/lungo/).\n\n## License\n\nThis project is licensed under the MIT License. See [LICENSE](LICENSE) for details.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A user-friendly home lab setup designed for small-to-mid-scale on-premises hosting.",
"version": "0.4.1",
"project_urls": {
"Documentation": "https://raymond-u.github.io/lungo/",
"Homepage": "https://github.com/raymond-u/lungo",
"Repository": "https://github.com/raymond-u/lungo"
},
"split_keywords": [
"homelab",
" self-host"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cdae162939c2235a8fee2ec6fb6591158276c1130fb05a76bade966252abd576",
"md5": "b3b6e7683029daca28838a41afe8c392",
"sha256": "545b12d50bab10d6f120096bb122dc8c4133541ec2d1343d204690a54be1fbf3"
},
"downloads": -1,
"filename": "lungo_cli-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3b6e7683029daca28838a41afe8c392",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 514013,
"upload_time": "2024-05-16T06:37:26",
"upload_time_iso_8601": "2024-05-16T06:37:26.276842Z",
"url": "https://files.pythonhosted.org/packages/cd/ae/162939c2235a8fee2ec6fb6591158276c1130fb05a76bade966252abd576/lungo_cli-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f58a3a6713c2da137ae469cfcba3fe7f77c20ef8294216f9fa8d8e28ec6adba6",
"md5": "cabda8d706859032cf2382fcbfbe4656",
"sha256": "2af07c5e49b02f9c7a6f6eb1c8330b98e806a80f9c65b92000715970cf563720"
},
"downloads": -1,
"filename": "lungo_cli-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "cabda8d706859032cf2382fcbfbe4656",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 418090,
"upload_time": "2024-05-16T06:37:28",
"upload_time_iso_8601": "2024-05-16T06:37:28.673735Z",
"url": "https://files.pythonhosted.org/packages/f5/8a/3a6713c2da137ae469cfcba3fe7f77c20ef8294216f9fa8d8e28ec6adba6/lungo_cli-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 06:37:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "raymond-u",
"github_project": "lungo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lungo-cli"
}
JSON
