From: William Desportes <redacted>
Date: Tue, 1 Aug 2023 21:39:55 +0000 (+0200)
Subject: Fix typos and improve the readme (#225)
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=10d35aa10a49bce7e880b21bde5cc5e123427c35;p=roundcube-roundcubemail-docker.git

Fix typos and improve the readme (#225)
---

diff --git a/README.md b/README.md
index b26d215..dbb73c7 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
 
-[![Build Status](https://travis-ci.org/roundcube/roundcubemail-docker.svg)](https://travis-ci.org/roundcube/roundcubemail-docker)
+[![Build & Test](https://github.com/roundcube/roundcubemail-docker/actions/workflows/test.yml/badge.svg)](https://github.com/roundcube/roundcubemail-docker/actions/workflows/test.yml)
 [![Docker Pulls](https://img.shields.io/docker/pulls/roundcube/roundcubemail.svg)](https://hub.docker.com/r/roundcube/roundcubemail/)
 
 # Running Roundcube in a Docker Container
 
 The simplest method is to run the official image:
 
-```
+```sh
 docker run -e ROUNDCUBEMAIL_DEFAULT_HOST=mail -e ROUNDCUBEMAIL_SMTP_SERVER=mail -p 8000:80 -d roundcube/roundcubemail
 ```
 
@@ -24,11 +24,11 @@ We also publish full version tags (e.g. `1.3.10`) but these just represent the v
 
 The following env variables can be set to configure your Roundcube Docker instance:
 
-`ROUNDCUBEMAIL_DEFAULT_HOST` - Hostname of the IMAP server to connect to. For encypted connections, prefix the host with `tls://` (STARTTLS) or `ssl://` (SSL/TLS).
+`ROUNDCUBEMAIL_DEFAULT_HOST` - Hostname of the IMAP server to connect to. For encrypted connections, prefix the host with `tls://` (STARTTLS) or `ssl://` (SSL/TLS).
 
 `ROUNDCUBEMAIL_DEFAULT_PORT` - IMAP port number; defaults to `143`
 
-`ROUNDCUBEMAIL_SMTP_SERVER` - Hostname of the SMTP server to send mails. For encypted connections, prefix the host with `tls://` (STARTTLS) or `ssl://` (SSL/TLS).
+`ROUNDCUBEMAIL_SMTP_SERVER` - Hostname of the SMTP server to send mails. For encrypted connections, prefix the host with `tls://` (STARTTLS) or `ssl://` (SSL/TLS).
 
 `ROUNDCUBEMAIL_SMTP_PORT`  - SMTP port number; defaults to `587`
 
@@ -42,7 +42,7 @@ The following env variables can be set to configure your Roundcube Docker instan
 
 `ROUNDCUBEMAIL_SPELLCHECK_URI` - Fully qualified URL to a Google XML spell check API like [google-spell-pspell](https://github.com/roundcube/google-spell-pspell)
 
-`ROUNDCUBEMAIL_ASPELL_DICTS` - List of aspell dictionaries to install for spell checking (comma-separated, e.g. `de,fr,pl`). 
+`ROUNDCUBEMAIL_ASPELL_DICTS` - List of aspell dictionaries to install for spell checking (comma-separated, e.g. `de,fr,pl`).
 
 By default, the image will use a local SQLite database for storing user account metadata.
 It'll be created inside the container directory `/var/roundcube/db`. In order to persist the database, a volume
@@ -69,7 +69,7 @@ has privileges to create tables.
 
 Run it with a link to the MySQL host and the username/password variables:
 
-```
+```sh
 docker run --link=mysql:mysql -d roundcube/roundcubemail
 ```
 
@@ -83,7 +83,7 @@ or to inject additional data into the container:
   This is the document root of Roundcube. Plugins and additional skins are stored here amongst the Roundcube sources.
   Share this directory when using the FPM variant and let a webserver container serve the static files from here.
 
-* `/var/roundcube/config`: Location for additonal config files  
+* `/var/roundcube/config`: Location for additional config files
   See the [Advanced configuration](#advanced-configuration) section for details.
 
 * `/var/roundcube/db`: storage location of the SQLite database  
@@ -96,7 +96,7 @@ or to inject additional data into the container:
 ## Docker Secrets
 
 When running the Roundcube container in a Docker Swarm, you can use [Docker Secrets](https://docs.docker.com/engine/swarm/secrets/)
-to share credentials accross all instances. The following secrets are currently supported by Roundcube:
+to share credentials across all instances. The following secrets are currently supported by Roundcube:
 
 * `roundcube_des_key`: Unique and random key for encryption purposes
 * `roundcube_db_user`: Database connection username (mappend to `ROUNDCUBEMAIL_DB_USER`)
@@ -109,7 +109,7 @@ which are merged into Roundcube's default config. Therefore the image defines th
 where additional config files (`*.php`) are searched and included. Mount a local directory with your config
 files - check for valid PHP syntax - when starting the Docker container:
 
-```
+```sh
 docker run -v ./config/:/var/roundcube/config/ -d roundcube/roundcubemail
 ```
 
@@ -124,8 +124,8 @@ With the latest updates, the Roundcube images contain the [Composer](https://get
 which is used to install plugins. You can add and activate plugins by executing `composer require <package-name>` 
 inside a running Roundcube container:
 
-```
-$ docker exec -it roundcubemail composer require johndoh/contextmenu --update-no-dev
+```sh
+docker exec -it roundcubemail composer require johndoh/contextmenu --update-no-dev
 ```
 
 If you have mounted the container's volume `/var/www/html` the plugins installed persist on your host system.
@@ -142,7 +142,7 @@ It pulls the latest build of Roundcube Webmail from the Github download page and
 
 Build it from one of the variants directories with
 
-```
+```sh
 docker build -t roundcubemail .
 ```