Update the Readme to include more details #1088
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,110 @@ | ||
| # <img src="./readmeAssets/img/komodo-512x512.png" width="50" alt="Komodo"> Komodo | ||
|
|
||
| Komodo is a Docker management UI which supports managing Docker containers and compose stacks across dozens of servers. | ||
| In addition to Docker management, Komodo provides tools for building and deploying software, including Git integration, build pipelines and secret management. | ||
|
|
||
| There is no limit to the number of servers you can connect, and there will never be. There is no limit to what API you can use for automation, and there never will be. No "business edition" here. | ||
|
|
||
| <div align="center"> | ||
| <img src="./readmeAssets/screenshots/Dark-Ligh-Stack.png" alt="Stack" style="max-width: 80%;"> | ||
| </div> | ||
|
|
||
| ___ | ||
|
|
||
| 🦎 [See the docs](https://komo.do) | ||
| 🦎 [Try the Demo](https://demo.komo.do) - Login: `demo` : `demo` | ||
| 🦎 [See the Build Server](https://build.komo.do) - Login: `komodo` : `komodo` | ||
| 🦎 [Join the Discord](https://discord.gg/DRqE8Fvg5c) | ||
|
|
||
| ## Features | ||
| ### Container & Stack management | ||
| - Manage Docker containers | ||
| - Create/Edtit/Remove | ||
| - (Re)Deploy/Pull Images/Pause/Stop/Destroy | ||
| - Web Editor for compose and config files | ||
| - Web terminal to access containers | ||
| - Auto Update | ||
| - Automatically update Containers or just notify when updates are available | ||
| - Pre and Post deployment scripts | ||
| - Private and Public Image Registries | ||
| - Templates | ||
| - Webhook support for automated redeployments | ||
|
|
||
| ### Build Management | ||
| - Separate build servers | ||
| - Build and Deploy on different servers to reduce load on production servers | ||
| - Auto version incrementing | ||
| - Source Dockerfile from Git, UI or filesystem | ||
| - Supports Private Git Repositories | ||
| - Publish to Image Registries | ||
| - Private and Public | ||
| - Pre build scripts | ||
| - Build args | ||
| - Webhook support for automated builds | ||
|
|
||
| ### Server Management | ||
| - Resource monitoring | ||
| - CPU, Memory, Disk, Network | ||
| - Per container resource usage | ||
| - Container, Network, Volume and Image listing and detail views | ||
| - Terminal (if activated in Periphery agent) | ||
|
|
||
| ### Procedures | ||
| Create multistep procedures to automate complex workflows. | ||
| - Combine build, deployment and actions | ||
| - Automate scheduled updating of containers | ||
| - Start/Stop/Restart containers/stacks on a schedule | ||
| - Execute with Webhooks, scheduled or manually | ||
|
|
||
| ### Actions | ||
| Script your own custom actions to do what you want. | ||
| - Automatically create new stacks | ||
| - Use external APIs | ||
| - Do whatever's not possible natively | ||
|
|
||
| [Action Docs](https://docs.rs/komodo_client/latest/komodo_client/api/index.html#modules) | ||
|
|
||
| ### General | ||
| - Alerting | ||
| - Filers to allow for spesific allerts only | ||
| - Multiple providers | ||
| - Discord | ||
| - Slack | ||
| - Ntfy | ||
| - Pushover | ||
| - OIDC Authentication | ||
|
Hutch79 marked this conversation as resolved.
Outdated
|
||
| - User Groups | ||
| - Granular, per-resource access control | ||
| - Per resource action log | ||
| - See exactly who did what and when | ||
| - Dark/Ligh themes | ||
|
|
||
| ## How to get started | ||
| Komodo needs a MongoDB database to store its data. | ||
| If you're not able to run MongoDB, it is possible to use PostgreSQL with FerretDB *translating* between the two. | ||
|
There was a problem hiding this comment. Also iirc FerretDB is being deprecated or something along the lines, so, that line may be outdated very soon
Author
There was a problem hiding this comment. Is feretdb itself being deprecated, or is this a Komodo V2 decision? |
||
|
|
||
| - [Setup Komodo with MongoDB](https://komo.do/docs/setup/mongo) | ||
| - [Setup Komodo with PostgreSQL and FerretDB](https://komo.do/docs/setup/ferretdb) | ||
| - [Add more servers to Komodo](https://komo.do/docs/setup/connect-servers) | ||
|
|
||
| ## Screenshots | ||
|
|
||
| | Dark Theme | Light Theme | | ||
| |---|---| | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
|
|
||
| ## Fun fact | ||
|
|
||
| The Komodo dragon is the largest living member of the [*Monitor* family of lizards](https://en.wikipedia.org/wiki/Monitor_lizard). | ||
|
|
||
| ## Disclaimer | ||
|
|
||
| Warning. This is open source software (GPLv3), and while we make a best effort to ensure releases are stable and bug-free, | ||
| there are no warranties. Use at your own risk. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.