README.md 951 Bytes
Newer Older
Bastien Le Querrec's avatar
Bastien Le Querrec committed
1
Website of the Silence project.
Bastien Le Querrec's avatar
Bastien Le Querrec committed
2
3
4
5
6
7
8
9
10
11
12
13
14

## Installation

Just clone or fork this repository and start the application with npm:

```
npm install
npm start
```

To customize some parameters, use environment variables:

```
15
TIMEOUT=2000 PORT=3000 npm start
Bastien Le Querrec's avatar
Bastien Le Querrec committed
16
17
18
19
20
21
```

## Requirements

You need Node.js and npm.

Bastien Le Querrec's avatar
Bastien Le Querrec committed
22
23
24
25
26
## Docker

To run this app into a Docker container, build the image and run it:

```
Bastien Le Querrec's avatar
Bastien Le Querrec committed
27
28
docker build -t "silence.im:latest" .
docker run --restart=always -d --publish 127.0.0.1:8080:80 silence.im:latest
Bastien Le Querrec's avatar
Bastien Le Querrec committed
29
30
31
32
```

Then, visit http://localhost:8080/.

Bastien Le Querrec's avatar
Bastien Le Querrec committed
33
34
35
36
37
38
39
40
41
## License

Licensed under the GNU Affero General Public License Version 3 (or later); you may not use this work except in compliance with the License.

You may obtain a copy of the License in the LICENSE file, or at:

http://www.gnu.org/licenses/agpl-3.0.txt

Pictures are licensed under the CC BY 2.0:
Bastien Le Querrec's avatar
Bastien Le Querrec committed
42
https://www.flickr.com/photos/bastienlq/19276132753/
Bastien Le Querrec's avatar
Bastien Le Querrec committed
43
https://www.flickr.com/photos/39908901@N06/6909402464/