diff --git a/README.md b/README.md index 223376e..7591a19 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,16 @@ under the same user permissions as yourself, from within your own `$HOME`. > containers, but it is not strictly required. Details for setting up a system > from scratch are located in [AlmaLinux.md](./AlmaLinux.md). +## Table of Contents + +- [Getting started](#getting-started) + - [Dependencies](#dependencies) + - [Quickstart](#quickstart) + - [Hello, world](#hello-world) + - [Running real apps](#running-real-apps) + - [Example](#example) +- [Coming soon](#coming-soon) + ## Getting started ### Dependencies @@ -123,7 +133,7 @@ Navigate to `http://localhost:9000` in your browser. > tcp LISTEN 0 4096 *:9000 *:* users:(("rootlessport",pid=913878,fd=10)) > ``` -## Upcoming containers +## Coming soon I'm working on new quadlets every day. This is a list of all of the containers that I intend to add to this repository. It is still growing, and I welcome @@ -136,6 +146,7 @@ that I intend to add to this repository. It is still growing, and I welcome - [ ] [Authelia](https://www.authelia.com/) - [ ] [Authentik](https://goauthentik.io/) - [ ] [betanin](https://github.com/sentriz/betanin) +- [ ] [Blinko](https://blinko.mintlify.app/introduction) - [x] [booktree](https://github.com/myxdvz/booktree) - [ ] [Cabot](https://cabotapp.com/) - [x] [Caddy](https://caddyserver.com) # Socket activation requires newer `caddy` and `podman` diff --git a/templates/template.container b/templates/template.container index 95f52dc..d250623 100644 --- a/templates/template.container +++ b/templates/template.container @@ -1,20 +1,21 @@ -# source: https://github.com/fpatrick/podman-quadlet +# original: https://github.com/fpatrick/podman-quadlet [Unit] Description= # (Optional) A brief description of the service Wants= # (Optional) Services you want to run with this one After= # (Optional) Services that need to start before this one +[Service] +Restart= # (Optional) Set to 'always' or 'on-failure' to restart on failure +TimeoutStartSec= # (Optional) Time to wait before considering a failure + +[Install] +WantedBy= # (Optional) Target to start with (default: multi-user.target). For graphical user interface systems default.target + [Container] -ContainerName= # (Mandatory) The container's name Image= # (Mandatory) The container image to use (e.g., docker.io/library/alpine) +ContainerName= # (Mandatory) The container's name HostName= # (Optional) The containers hostname -EnvironmentFile= # (Optional) Path to an .env file -Environment= # (Optional) Key=value pairs for environment variables -Volume= # (Optional) Persistent storage paths (host:container) -Network= # (Optional) Custom network for the container -PublishPort= # (Optional) Ports to expose (host:container) -Exec= # (Optional) Custom command to run in the container -PodmanArgs= # (Optional) Additional Podman arguments + AddCapability= # (Optional) Extra capabilities to add to the container AddDevice= # (Optional) Add host devices to the container SecurityLabelDisable= # (Optional) Disable SELinux labels @@ -23,9 +24,13 @@ Label= # (Optional) Add metadata labels to the container UIDMap= # (Optional) User ID mapping. Example: 0:10000:10 (Inside:Outside:Range) GIDMap= # (Optional) Group ID mapping Example: 0:10000:10 (Inside:Outside:Range) -[Service] -Restart= # (Optional) Set to 'always' or 'on-failure' to restart on failure -TimeoutStartSec= # (Optional) Time to wait before considering a failure +Network= # (Optional) Custom network for the container +PublishPort= # (Optional) Ports to expose (host:container) -[Install] -WantedBy= # (Optional) Target to start with (default: multi-user.target). For graphical user interface systems default.target +Volume= # (Optional) Persistent storage paths (host:container) + +EnvironmentFile= # (Optional) Path to an .env file +Environment= # (Optional) Key=value pairs for environment variables + +PodmanArgs= # (Optional) Additional Podman arguments +Exec= # (Optional) Custom command to run in the container