Skip to content

Commit 113fe4f

Browse files
authored
Merge pull request #2062 from kalsi-avneet/master
Docker - Update documentation for installation
2 parents b3711b4 + 4ce5a1d commit 113fe4f

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

DOCUMENTATION.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2783,7 +2783,10 @@ You can find the source packages of all releases on
27832783
27842784
#### Docker
27852785
2786-
Radicale is available as a [Docker image](https://github.com/Kozea/Radicale/pkgs/container/radicale) for platforms `linux/amd64` and `linux/arm64`.
2786+
Radicale is available as a Docker image for platforms `linux/amd64` and `linux/arm64` on:
2787+
2788+
* [Docker Hub](https://hub.docker.com/r/kozea/radicale), and
2789+
* [GitHub's Container Registry](https://github.com/Kozea/Radicale/pkgs/container/radicale)
27872790
27882791
Here are the steps to install Radicale via Docker Compose:
27892792
@@ -2815,7 +2818,11 @@ Here are the steps to install Radicale via Docker Compose:
28152818
28162819
3. Create Radicale configuration file as necessary
28172820
2818-
Create new or place existing configuration file in the `./config` directory.
2821+
Create a new configuration file or place an existing one in the `./config` directory.
2822+
2823+
2824+
**Note**: This section demonstrates only basic steps to setup Radicale using `docker compose`. For details on configuring Radicale, including authentication, please refer to the documentation for [Basic Configuration](#basic-configuration) or detailed [Configuration](#configuration)
2825+
28192826
28202827
4. Start Radicale
28212828
@@ -2825,6 +2832,28 @@ Here are the steps to install Radicale via Docker Compose:
28252832
28262833
This will start the Radicale container in detached mode.
28272834
2835+
2836+
To view the logs of the running container, run:
2837+
2838+
```bash
2839+
$ docker compose logs -f
2840+
```
2841+
2842+
To stop the container, run this from the current directory:
2843+
2844+
```bash
2845+
$ docker compose down
2846+
```
2847+
2848+
##### Available tags
2849+
2850+
* `stable`: Points to the latest stable release. This is recommended for most users.
2851+
* Major.Minor.Patch (e.g. `3.6.1`): Points to a specific release version.
2852+
* Major.Minor (e.g. `3.6`): Tracks the latest release for a minor version.
2853+
* Major (e.g. `3`): Tracks the latest release for a major version.
2854+
* nightly tags (e.g. `nightly-20260206`): Nightly builds.
2855+
* `latest`: Points to the most recent build. In most cases, this is nightly.
2856+
28282857
#### Linux Distribution Packages
28292858
28302859
Radicale has been packaged for:

0 commit comments

Comments
 (0)