Skip to content

Commit 9e4e4a8

Browse files
committed
fix markdown issues
1 parent 93d0976 commit 9e4e4a8

File tree

1 file changed

+30
-60
lines changed

1 file changed

+30
-60
lines changed

friendica/content.md

Lines changed: 30 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,24 @@
11
# What is Friendica?
22

3-
Friendica is a decentralised communications platform that integrates social communication.
4-
Our platform links to independent social projects and corporate services.
3+
Friendica is a decentralised communications platform that integrates social communication. Our platform links to independent social projects and corporate services.
54

65
![logo](https://cdn.rawgit.com/friendica/docker/9c954f4d/friendica.svg)
76

87
# How to use this image
98

10-
The images are designed to be used in a micro-service environment.
11-
There are two types of the image you can choose from.
9+
The images are designed to be used in a micro-service environment. There are two types of the image you can choose from.
1210

13-
The `apache` tag contains a full Friendica installation including an apache web server.
14-
It is designed to be easy to use and gets you running pretty fast.
15-
This is also the default for the `latest` tag and version tags that are not further specified.
11+
The `apache` tag contains a full Friendica installation including an apache web server. It is designed to be easy to use and gets you running pretty fast. This is also the default for the `latest` tag and version tags that are not further specified.
1612

17-
The second option is a `fpm` container.
18-
It is based on the [php-fpm](https://hub.docker.com/_/php/) image and runs a fastCGI-Process that serves your Friendica server.
19-
To use this image it must be combined with any Webserver that can proxy the http requests to the FastCGI-port of the container.
13+
The second option is a `fpm` container. It is based on the [php-fpm](https://hub.docker.com/_/php/) image and runs a fastCGI-Process that serves your Friendica server. To use this image it must be combined with any Webserver that can proxy the http requests to the FastCGI-port of the container.
2014

21-
[![Try in PWD](https://github.com/play-with-docker/stacks/raw/cff22438cb4195ace27f9b15784bbb497047afa7/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/nupplaphil/friendica-docker/fec33c98be957436279b7074ca08068b18622627/stack.yml)
22-
(Admin-E-Mail: `[email protected]`)
15+
[![Try in PWD](https://github.com/play-with-docker/stacks/raw/cff22438cb4195ace27f9b15784bbb497047afa7/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/nupplaphil/friendica-docker/fec33c98be957436279b7074ca08068b18622627/stack.yml) (Admin-E-Mail: `[email protected]`)
2316

2417
## Using the apache image
2518

2619
You need at least one other mariadb/mysql-container to link it to Friendica.
2720

28-
The apache image contains a webserver and exposes port 80.
29-
To start the container type:
21+
The apache image contains a webserver and exposes port 80. To start the container type:
3022

3123
```console
3224
$ docker run -d -p 8080:80 --link some-mysql:mysql friendica/server
@@ -36,20 +28,13 @@ Now you can access the Friendica installation wizard at http://localhost:8080/ f
3628

3729
## Using the fpm image
3830

39-
To use the fpm image you need an additional web server that can proxy http-request to the fpm-port of the container.
40-
For fpm connection this container exposes port 9000.
41-
In most cases you might want use another container or your host as proxy.
42-
If you use your host you can address your Friendica container directly on port 9000.
43-
If you use another container, make sure that you add them to the same docker network (via `docker run --network <NAME> ...` or a `docker-compose` file).
44-
In both cases you don't want to map the fpm port to you host.
31+
To use the fpm image you need an additional web server that can proxy http-request to the fpm-port of the container. For fpm connection this container exposes port 9000. In most cases you might want use another container or your host as proxy. If you use your host you can address your Friendica container directly on port 9000. If you use another container, make sure that you add them to the same docker network (via `docker run --network <NAME> ...` or a `docker-compose` file). In both cases you don't want to map the fpm port to you host.
4532

4633
```console
4734
$ docker run -d friendica/server:fpm
4835
```
4936

50-
As the fastCGI-Process is not capable of serving static files (style sheets, images, ...) the webserver needs access to these files.
51-
This can be achieved with the `volumes-from` option.
52-
You can find more information in the docker-compose section.
37+
As the fastCGI-Process is not capable of serving static files (style sheets, images, ...) the webserver needs access to these files. This can be achieved with the `volumes-from` option. You can find more information in the docker-compose section.
5338

5439
## Using the cron job
5540

@@ -62,6 +47,7 @@ There are three options to enable the cron-job for Friendica:
6247
## Possible Environment Variables
6348

6449
**Friendica Settings**
50+
6551
- `FRIENDICA_ADMIN_MAIL` E-Mail address of the administrator.
6652
- `FRIENDICA_TZ` The default localization of the Friendica server.
6753
- `FRIENDICA_LANG` The default language of the Friendica server.
@@ -72,11 +58,13 @@ There are three options to enable the cron-job for Friendica:
7258
- `FRIENDICA_DATA_DIR` The data directory of the Friendica server (Default: /var/www/data).
7359

7460
**Friendica Logging**
61+
7562
- `FRIENDICA_DEBUGGING` If set to `true`, the logging of Friendica is enabled.
7663
- `FRIENDICA_LOGFILE` (optional) The path to the logfile (Default: /var/www/friendica.log).
7764
- `FRIENDICA_LOGLEVEL` (optional) The loglevel to log (Default: notice).
7865

7966
**Database** (**required at installation**)
67+
8068
- `MYSQL_USERNAME` Username for the database user using mysql.
8169
- `MYSQL_USER` Username for the database user using mariadb.
8270
- `MYSQL_PASSWORD` Password for the database user using mysql / mariadb.
@@ -85,12 +73,14 @@ There are three options to enable the cron-job for Friendica:
8573
- `MYSQL_PORT` Port of the database server using mysql / mariadb (Default: `3306`)
8674

8775
**Lock Driver (Redis)**
76+
8877
- `REDIS_HOST` The hostname of the redis instance (in case of locking).
8978
- `REDIS_PORT` (optional) The port of the redis instance (in case of locking).
9079
- `REDIS_PW` (optional) The password for the redis instance (in case of locking).
9180
- `REDIS_DB` (optional) The database instance of the redis instance (in case of locking).
9281

9382
**Develop/Release Candidat Settings**
83+
9484
- `FRIENDICA_UPGRADE` If set to `true`, a develop or release candidat node will get updated at startup.
9585
- `FRIENDICA_REPOSITORY` If set, a custom repository will be chosen (Default: `friendica`)
9686
- `FRIENDICA_ADDONS_REPO` If set, a custom repository for the addons will be chosen (Default: `friendica`)
@@ -107,8 +97,7 @@ The binary `ssmtp` is used for the `mail()` support of Friendica.
10797

10898
You have to set the `--hostname/-h` parameter correctly to use the right domainname for the `mail()` command.
10999

110-
You have to set a valid SMTP-MTA for the `SMTP` environment variable to enable mail support in Friendica.
111-
A valid SMTP-MTA would be, for example, `mx.example.org`.
100+
You have to set a valid SMTP-MTA for the `SMTP` environment variable to enable mail support in Friendica. A valid SMTP-MTA would be, for example, `mx.example.org`.
112101

113102
The following environment variables are possible for the SMTP examples.
114103

@@ -127,12 +116,9 @@ You have to link a running database container, e. g. `--link my-mysql:mysql`, an
127116

128117
## Persistent data
129118

130-
The Friendica installation and all data beyond what lives in the database (file uploads, etc) is stored in the [unnamed docker volume](https://docs.docker.com/engine/tutorials/dockervolumes/#adding-a-data-volume) volume `/var/www/html`.
131-
The docker daemon will store that data within the docker directory `/var/lib/docker/volumes/...`.
132-
That means your data is saved even if the container crashes, is stopped or deleted.
119+
The Friendica installation and all data beyond what lives in the database (file uploads, etc) is stored in the [unnamed docker volume](https://docs.docker.com/engine/tutorials/dockervolumes/#adding-a-data-volume) volume `/var/www/html`. The docker daemon will store that data within the docker directory `/var/lib/docker/volumes/...`. That means your data is saved even if the container crashes, is stopped or deleted.
133120

134-
To make your data persistent to upgrading and get access for backups is using named docker volume or mount a host folder.
135-
To achieve this you need one volume for your database container and Friendica.
121+
To make your data persistent to upgrading and get access for backups is using named docker volume or mount a host folder. To achieve this you need one volume for your database container and Friendica.
136122

137123
Friendica:
138124

@@ -156,9 +142,7 @@ $ docker run -d \
156142

157143
## Automatic installation
158144

159-
The Friendica image supports auto configuration via environment variables.
160-
You can preconfigure everything that is asked on the install page on first run.
161-
To enable the automatic installation, there are two possibilities:
145+
The Friendica image supports auto configuration via environment variables. You can preconfigure everything that is asked on the install page on first run. To enable the automatic installation, there are two possibilities:
162146

163147
### Environment Variables
164148

@@ -172,16 +156,13 @@ You have to set at least the following environment variables (others are optiona
172156

173157
### Using a predefined config file
174158

175-
You can create a `local.config.php` and `COPY` it to `/usr/src/config`.
176-
If no other environment variable is set, this `local.config.php` will get copied to the config path.
159+
You can create a `local.config.php` and `COPY` it to `/usr/src/config`. If no other environment variable is set, this `local.config.php` will get copied to the config path.
177160

178161
# Docker Secrets
179162

180163
More information can be found here https://docs.docker.com/engine/swarm/secrets/.
181164

182-
As an alternative to passing sensitive information via environment variables, _FILE may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container.
183-
In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name> files.
184-
For example:
165+
As an alternative to passing sensitive information via environment variables, _FILE may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name> files. For example:
185166

186167
```yaml
187168
version: '3.2'
@@ -226,41 +207,34 @@ secrets:
226207
mysql_password:
227208
file: ./mysql_password.txt # put mysql password to this file using docker-secrets to manage it
228209
```
210+
229211
Currently, this is only supported for `MYSQL_PASSWORD`.
230212

231213
# Maintenance of the image
232214

233215
## Updating to a newer version
234216

235-
There are differences between the deveop (everything which ends with `-rc` or `-dev`) and the stable (the rest) branches.
217+
There are differences between the develop (everything which ends with `-rc` or `-dev`) and the stable (the rest) branches.
236218

237219
### Updating stable
238220

239-
You have to pull the latest image from the hub (`docker pull friendica`).
240-
The stable branch gets checked at every startup and will get updated if no installation was found or a new image is used.
221+
You have to pull the latest image from the hub (`docker pull friendica`). The stable branch gets checked at every startup and will get updated if no installation was found or a new image is used.
241222

242223
### Updating develop
243224

244-
You don't need to pull the image for each commit in [friendica](https://github.com/friendica/friendica/).
245-
Instead, the develop branch will get updated if no installation was found or the environment variable `FRIENDICA_UPGRADE` is set to `true`.
225+
You don't need to pull the image for each commit in [friendica](https://github.com/friendica/friendica/). Instead, the develop branch will get updated if no installation was found or the environment variable `FRIENDICA_UPGRADE` is set to `true`.
246226

247227
It will clone the latest Friendica version and copy it to your working directory.
248228

249229
# Running this image with docker-compose
250230

251-
The easiest way to get a fully featured and functional setup is using a `docker-compose` file.
252-
There are too many different possibilities to setup your system, so here are only some examples what you have to look for.
231+
The easiest way to get a fully featured and functional setup is using a `docker-compose` file. There are too many different possibilities to setup your system, so here are only some examples what you have to look for.
253232

254-
At first make sure you have chosen the right base image (fpm or apache) and added the features you wanted (see below).
255-
In every case you want to add a database container and docker volumes to get easy access to your persistent data.
256-
When you want your server reachable from the internet adding HTTPS-encryption is mandatory!
257-
See below for more information.
233+
At first make sure you have chosen the right base image (fpm or apache) and added the features you wanted (see below). In every case you want to add a database container and docker volumes to get easy access to your persistent data. When you want your server reachable from the internet adding HTTPS-encryption is mandatory! See below for more information.
258234

259235
## Base version - apache
260236

261-
This version will use the apache image and add a mariaDB container.
262-
The volumes are set to keep your data persistent.
263-
This setup provides **no ssl encryption** and is intended to run behind a proxy.
237+
This version will use the apache image and add a mariaDB container. The volumes are set to keep your data persistent. This setup provides **no ssl encryption** and is intended to run behind a proxy.
264238

265239
Make sure to set the variable `MYSQL_PASSWORD` before run this setup.
266240

@@ -305,20 +279,16 @@ Then run `docker-compose up -d`, now you can access Friendica at http://localhos
305279

306280
## Base version - FPM
307281

308-
When using the FPM image you need another container that acts as web server on port 80 and proxies requests to the Friendica container.
309-
In this example a simple nginx container is combined with the Friendica-fpm image and a MariaDB database container.
310-
The data is stored in docker volumes.
311-
The nginx container also need access to static files from your Friendica installation.
312-
It gets access to all the volumes mounted to Friendica via the `volumes_from` option.
313-
The configuration for nginx is stored in the configuration file `nginx.conf` that is mounted into the container.
282+
When using the FPM image you need another container that acts as web server on port 80 and proxies requests to the Friendica container. In this example a simple nginx container is combined with the Friendica-fpm image and a MariaDB database container. The data is stored in docker volumes. The nginx container also need access to static files from your Friendica installation. It gets access to all the volumes mounted to Friendica via the `volumes_from` option. The configuration for nginx is stored in the configuration file `nginx.conf` that is mounted into the container.
314283

315284
An example can be found in the [examples section](https://github.com/friendica/docker/tree/master/.examples).
316285

317286
As this setup does **not include encryption** it should to be run behind a proxy.
318287

319288
Prerequisites for this example:
320-
- Make sure to set the variable `MYSQL_PASSWORD` before you run the setup.
321-
- Create a `nginx.conf` in the same directory as the docker-compose.yml file (take it from [example](https://github.com/friendica/docker/tree/master/.examples/docker-compose/with-traefik-proxy/mariadb-cron-smtp/fpm/web/nginx.conf))
289+
290+
- Make sure to set the variable `MYSQL_PASSWORD` before you run the setup.
291+
- Create a `nginx.conf` in the same directory as the docker-compose.yml file (take it from [example](https://github.com/friendica/docker/tree/master/.examples/docker-compose/with-traefik-proxy/mariadb-cron-smtp/fpm/web/nginx.conf))
322292

323293
```yaml
324294
version: '2'

0 commit comments

Comments
 (0)