aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-01-12 09:40:05 +0100
committerChocobozzz <me@florianbigard.com>2021-01-12 09:40:05 +0100
commitf930450a82f25f086186146044737cbef0452fec (patch)
treed7d8d4e4793ff2da2210c188917aebc289edb876
parent8ace68056dedefc3cff696d2cd52832b89c2c845 (diff)
downloadPeerTube-f930450a82f25f086186146044737cbef0452fec.tar.gz
PeerTube-f930450a82f25f086186146044737cbef0452fec.tar.zst
PeerTube-f930450a82f25f086186146044737cbef0452fec.zip
Clearer docker doc hierarchy
-rw-r--r--support/doc/docker.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/support/doc/docker.md b/support/doc/docker.md
index 9be5c5a82..d83ee3997 100644
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -3,9 +3,7 @@
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/). 4[docker-compose](https://docs.docker.com/compose/install/).
5 5
6## Production 6## Install
7
8### Install
9 7
10**PeerTube does not support webserver host change**. Keep in mind your domain 8**PeerTube does not support webserver host change**. Keep in mind your domain
11name is definitive after your first PeerTube start. 9name is definitive after your first PeerTube start.
@@ -86,7 +84,7 @@ Run your containers:
86docker-compose up 84docker-compose up
87``` 85```
88 86
89### Obtaining your automatically-generated admin credentials 87#### Obtaining your automatically-generated admin credentials
90 88
91Now 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. 89Now 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.
92 90
@@ -97,7 +95,7 @@ peertube_1 | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root
97peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop 95peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop
98``` 96```
99 97
100### Obtaining Your Automatically Generated DKIM DNS TXT Record 98#### Obtaining Your Automatically Generated DKIM DNS TXT Record
101 99
102[DKIM](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail) signature sending and RSA keys generation are enabled by the default Postfix image `mwader/postfix-relay` with [OpenDKIM](http://www.opendkim.org/). 100[DKIM](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail) signature sending and RSA keys generation are enabled by the default Postfix image `mwader/postfix-relay` with [OpenDKIM](http://www.opendkim.org/).
103 101
@@ -111,15 +109,15 @@ peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; "
111 "j5joTnYwat4387VEUyGUnZ0aZxCERi+ndXv2/wMJ0tizq+a9+EgqIb+7lkUc2XciQPNuTujM25GhrQBEKznvHyPA6fHsFheymOuB763QpkmnQQLCxyLygAY9mE/5RY+5Q6J9oDOQIDAQAB" ) ; ----- DKIM key peertube for mydomain.tld 109 "j5joTnYwat4387VEUyGUnZ0aZxCERi+ndXv2/wMJ0tizq+a9+EgqIb+7lkUc2XciQPNuTujM25GhrQBEKznvHyPA6fHsFheymOuB763QpkmnQQLCxyLygAY9mE/5RY+5Q6J9oDOQIDAQAB" ) ; ----- DKIM key peertube for mydomain.tld
112``` 110```
113 111
114### Administrator password 112#### Administrator password
115 113
116See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator) 114See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator)
117 115
118### What now? 116#### What now?
119 117
120See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now). 118See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now).
121 119
122### Upgrade 120## Upgrade
123 121
124**Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/config/production.yaml). 122**Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/config/production.yaml).
125 123
@@ -142,7 +140,9 @@ Rerun PeerTube:
142$ docker-compose up -d 140$ docker-compose up -d
143``` 141```
144 142
145## Build your own Docker image 143## Build
144
145### Production
146 146
147```shell 147```shell
148$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube 148$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
@@ -150,6 +150,6 @@ $ cd /tmp/peertube
150$ docker build . -f ./support/docker/production/Dockerfile.buster 150$ docker build . -f ./support/docker/production/Dockerfile.buster
151``` 151```
152 152
153## Development 153### Development
154 154
155We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop) for more information on how you can hack PeerTube! 155We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop) for more information on how you can hack PeerTube!