Browse Source

Update Docker docs, add badge to README

Danilo Bargen 6 năm trước cách đây
mục cha
commit
534053d138
3 tập tin đã thay đổi với 10 bổ sung13 xóa
  1. 1 0
      README.md
  2. 8 12
      docs/docker.md
  3. 1 1
      docs/self_hosting.md

+ 1 - 0
README.md

@@ -2,6 +2,7 @@
 
 
 [![Build status](https://circleci.com/gh/threema-ch/threema-web.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/threema-ch/threema-web)
 [![Build status](https://circleci.com/gh/threema-ch/threema-web.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/threema-ch/threema-web)
 [![License](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://github.com/threema-ch/threema-web/blob/master/LICENSE.txt)
 [![License](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://github.com/threema-ch/threema-web/blob/master/LICENSE.txt)
+[![Docker Image](https://img.shields.io/badge/docker%20image-threema%2Fthreema--web-yellow.svg)](https://hub.docker.com/r/threema/threema-web)
 
 
 Threema Web is a web client for Threema, a privacy-focussed end-to-end
 Threema Web is a web client for Threema, a privacy-focussed end-to-end
 encrypted mobile messenger hosted and developed in Switzerland. With Threema
 encrypted mobile messenger hosted and developed in Switzerland. With Threema

+ 8 - 12
docs/docker.md

@@ -1,14 +1,11 @@
 # Running Threema Web with Docker
 # Running Threema Web with Docker
 
 
+A Docker image with Threema Web is published on Docker Hub at
+[`threema/threema-web`](https://hub.docker.com/r/threema/threema-web).
 
 
-## Building the Image
+Alternatively you can build the image yourself:
 
 
-To build the Docker image:
-
-    $ docker build . -t example/threema-web:latest
-
-
-## Running the Image
+    $ docker build . -t threema/threema-web:v2.1
 
 
 To run the Docker image:
 To run the Docker image:
 
 
@@ -24,8 +21,7 @@ mechanisms in your web server.
 
 
 ## Config Variables
 ## Config Variables
 
 
-| Variable | Default | Description |
-| -------- | ------- | ----------- |
-| `SALTYRTC_HOST` | null | The SaltyRTC signaling server hostname |
-| `SALTYRTC_PORT` | 443 | The SaltyRTC signaling server port |
-| `SALTYRTC_SERVER_KEY` | "b1337fc8402f7db8ea639e05ed05d65463e24809792f91eca29e88101b4a2171" | The SaltyRTC signaling server public key |
+- `SALTYRTC_HOST`: The SaltyRTC signaling server hostname (default `null`)
+- `SALTYRTC_PORT`: The SaltyRTC signaling server port (default `443`)
+- `SALTYRTC_SERVER_KEY`: The SaltyRTC signaling server public key
+  (default `"b1337fc8402f7db8ea639e05ed05d65463e24809792f91eca29e88101b4a2171"`)

+ 1 - 1
docs/self_hosting.md

@@ -22,7 +22,7 @@ that is required to host it is a web server that can deliver static content via
 https. We recommend using Nginx. Additionally, to build the release version
 https. We recommend using Nginx. Additionally, to build the release version
 yourself, a recent version of npm is required.
 yourself, a recent version of npm is required.
 
 
-### Building
+### Building from source
 
 
 You can get the source code from Github:
 You can get the source code from Github: