Skip to content

Commit

Permalink
Wording and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
datze authored May 5, 2019
1 parent e8527df commit 5937710
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# DAViCal Docker Container
Dockerfile for a complete [DAViCal](https://www.davical.org/) server (DAViCal + apache + postgresql) on Alpine Linux.
This simple repository contains a Dockerfile (and other configuration files) necessary to create an Alpine Linux image contains Davical + Apache + Postgresql server.

Davical is downloaded directly from its git repository while apache and postgres are installed from alpine linux repository.
Docker image for a complete [DAViCal](https://www.davical.org/) server (DAViCal + Apache2 + PostgreSQL) on Alpine Linux.
The repository on github.org contains example configuration files for DAViCal (as well as the Dockerfile to create the Docker image).

### About DAViCal
[DAViCal](https://www.davical.org/) is a server for shared calendars. It implements the [CalDAV protocol](https://wikipedia.org/wiki/CalDAV) and stores calendars in the [iCalendar format](https://wikipedia.org/wiki/ICalendar).
Expand Down Expand Up @@ -40,7 +38,7 @@ So you can download the configuration files present in this repository, alter an
To use HTTPS on TCP port 433, you need to uncomment the related lines in apache.conf and provide a SSL certificate for your domain in /config.

/var/lib/postgresql/data contains the database and the directory backups/. In this directory crond every day saves (thanks to /sbin/backup_db) a dump of DAViCal database to backups/davical_backup.tar
It is possible to restore the database using a backup: puit the backup into the mounted /config, run the container and after the initialization use "docker exec container_name /sbin/restore_db"
It is possible to restore the database using a backup: put the backup into the mounted /config, run the container and after the initialization use "docker exec container_name /sbin/restore_db"

The rsyslog server is configured to collect all logs from apache and postgres into /var/log/messages but you can personalize the configuration altering rsyslog.conf and put it in /config. rsyslog does NOT collect apache access.log (it is disabled)

Expand All @@ -52,7 +50,7 @@ The **default admin user** is: *admin* with password: *12345* (you can alter it
```
docker run -d --name davical-test -p 8080:80 datze/davical_https
```
Creates and runs a DAViCal Docker container which is fully operable on host TCP port 8080. Does not require any further configuration. *Attention! Only for testing! When the container is deleted, all stored calendes are lost!*
Creates and runs a DAViCal Docker container which is fully operable on host TCP port 8080. Does not require any further configuration. *Attention! Only for testing! When the container is deleted, all stored calendars are lost!*

**Simple HTTP mode**
```
Expand All @@ -69,7 +67,7 @@ The time zone is set to Europe/Berlin and the hostname is my.example.com.

The **config files must be created in /var/davical/config** and the **database files are stored in /var/davical/data**.

A SSL certificate must be placed in /var/davical/config and references in /var/davical/config/apache.conf. (Create a self-signed certificate with something like `openssl req -x509 -newkey rsa:4096 -keyout /var/davical/config/ssl/private.pem -out /var/davical/config/ssl/cert.pem -days 1000`)
A SSL certificate must be placed in /var/davical/config and referenced in /var/davical/config/apache.conf. (Create a self-signed certificate with something like `openssl req -x509 -newkey rsa:4096 -keyout /var/davical/config/ssl/private.pem -out /var/davical/config/ssl/cert.pem -days 1000`)

### Credits
Based on https://github.com/IridiumXOR/davical and https://hub.docker.com/r/oliveria/davical (no HTTPS, older PG and PHP versions).

0 comments on commit 5937710

Please sign in to comment.