aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2020-11-11 12:55:13 +0100
committerRigel Kent <sendmemail@rigelk.eu>2020-11-11 16:45:46 +0100
commita30995fc27e697359d195e5c03127034d9c4e7ca (patch)
treeeee5b6d4984dac07c6641d628fe54536130d9119 /support/doc
parentb8f3e6b00b3300f4ebf37bf77711739964c9e5d6 (diff)
downloadPeerTube-a30995fc27e697359d195e5c03127034d9c4e7ca.tar.gz
PeerTube-a30995fc27e697359d195e5c03127034d9c4e7ca.tar.zst
PeerTube-a30995fc27e697359d195e5c03127034d9c4e7ca.zip
consistent documentation and configuration in compose file
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/docker-traefik.md2
-rw-r--r--support/doc/docker.md12
2 files changed, 8 insertions, 6 deletions
diff --git a/support/doc/docker-traefik.md b/support/doc/docker-traefik.md
index fcd63364a..eb480ec53 100644
--- a/support/doc/docker-traefik.md
+++ b/support/doc/docker-traefik.md
@@ -40,5 +40,5 @@ More at: https://docs.traefik.io/v1.7
40#### Run with traefik 40#### Run with traefik
41 41
42```shell 42```shell
43docker-compose -f {docker-compose.yml,docker-compose.traefik.yml} up -d 43docker-compose -f docker-compose.yml docker-compose.traefik.yml up -d
44``` 44```
diff --git a/support/doc/docker.md b/support/doc/docker.md
index e55aee9fc..cf3a0db0b 100644
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -1,7 +1,7 @@
1# Docker guide 1# Docker guide
2 2
3This guide requires [docker](https://www.docker.com/community-edition) and 3This guide requires [docker](https://www.docker.com/community-edition) and
4[docker-compose](https://docs.docker.com/compose/install/) installed. 4[docker-compose](https://docs.docker.com/compose/install/).
5 5
6## Production 6## Production
7 7
@@ -10,7 +10,9 @@ This guide requires [docker](https://www.docker.com/community-edition) and
10**PeerTube does not support webserver host change**. Keep in mind your domain 10**PeerTube does not support webserver host change**. Keep in mind your domain
11name is definitive after your first PeerTube start. 11name is definitive after your first PeerTube start.
12 12
13#### Go to your peertube workdir 13#### Go to your workdir
14
15_note_: the guide that follows assumes an empty workdir, but you can also clone the repository, use the master branch and `cd support/docker/production`.
14 16
15```shell 17```shell
16cd /your/peertube/directory 18cd /your/peertube/directory
@@ -38,7 +40,7 @@ View the source of the file you're about to download: [.env](https://github.com/
38$EDITOR ./docker-compose.yml 40$EDITOR ./docker-compose.yml
39``` 41```
40 42
41#### Then tweak the `.env` file to change the environment variables 43#### Then tweak the `.env` file to change the environment variables settings
42 44
43```shell 45```shell
44$EDITOR ./.env 46$EDITOR ./.env
@@ -72,7 +74,7 @@ docker-compose up
72Now that you've installed your PeerTube instance you'll want to grep your peertube container's logs for the `root` password. You're going to want to run `docker-compose logs peertube | grep -A1 root` to search the log output for your new PeerTube's instance admin credentials which will look something like this. 74Now that you've installed your PeerTube instance you'll want to grep your peertube container's logs for the `root` password. You're going to want to run `docker-compose logs peertube | grep -A1 root` to search the log output for your new PeerTube's instance admin credentials which will look something like this.
73 75
74```bash 76```bash
75user@s:~/peertube|master⚡ docker-compose logs peertube | grep -A1 root 77$ docker-compose logs peertube | grep -A1 root
76 78
77peertube_1 | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root 79peertube_1 | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root
78peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop 80peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop
@@ -85,7 +87,7 @@ peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abc
85Run `cat ./docker-volume/opendkim/keys/*/*.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain : 87Run `cat ./docker-volume/opendkim/keys/*/*.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain :
86 88
87```bash 89```bash
88user@s:~/peertube|master⚡ cat ./docker-volume/opendkim/keys/*/*.txt 90$ cat ./docker-volume/opendkim/keys/*/*.txt
89 91
90peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; " 92peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; "
91 "p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Dx7wLGPFVaxVQ4TGym/eF89aQ8oMxS9v5BCc26Hij91t2Ci8Fl12DHNVqZoIPGm+9tTIoDVDFEFrlPhMOZl8i4jU9pcFjjaIISaV2+qTa8uV1j3MyByogG8pu4o5Ill7zaySYFsYB++cHJ9pjbFSC42dddCYMfuVgrBsLNrvEi3dLDMjJF5l92Uu8YeswFe26PuHX3Avr261n" 93 "p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Dx7wLGPFVaxVQ4TGym/eF89aQ8oMxS9v5BCc26Hij91t2Ci8Fl12DHNVqZoIPGm+9tTIoDVDFEFrlPhMOZl8i4jU9pcFjjaIISaV2+qTa8uV1j3MyByogG8pu4o5Ill7zaySYFsYB++cHJ9pjbFSC42dddCYMfuVgrBsLNrvEi3dLDMjJF5l92Uu8YeswFe26PuHX3Avr261n"