Skip to content

Commit

Permalink
clarify quick installation guides
Browse files Browse the repository at this point in the history
  • Loading branch information
pbiering committed Jan 26, 2025
1 parent 98e65d8 commit 780aaa7
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Radicale is a small but powerful CalDAV (calendars, to-do lists) and CardDAV
Radicale is really easy to install (for testing purposes) and works out-of-the-box.

```bash
python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
# Run as normal user
python3 -m pip install --user --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
python3 -m radicale --logging-level info --storage-filesystem-folder=~/.var/lib/radicale/collections
```

Expand Down Expand Up @@ -63,10 +64,20 @@ enough to install the package ``python3-pip``.
Then open a console and type:

```bash
# Run the following command as root or
# add the --user argument to only install for the current user
$ python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
$ python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections
# Run the following command to only install for the current user
# data is also stored for the current user only
python3 -m pip install --user --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections
```

Alternative one can install as root or system user

```bash
# Run the following command as root
# or non-root system user (can require --user in case of dependencies are not available system-wide)
# requires existence of and write permissions to /var/lib/radicale/collections
python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
python3 -m radicale --storage-filesystem-folder=/var/lib/radicale/collections
```

Victory! Open <http://localhost:5232> in your browser!
Expand Down

0 comments on commit 780aaa7

Please sign in to comment.