Skip to content

Commit 2b44dc6

Browse files
committed
README: add docs for Docker
1 parent ebd8945 commit 2b44dc6

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,41 @@ Using a personal access token would of course solve the first problem, but a per
1717

1818
## How?
1919

20-
Install the [Codenotify](https://github.com/apps/codenotify) GitHub App on your repositories and add some [CODENOTIFY files](https://github.com/sourcegraph/codenotify#codenotify-files).
20+
### Free public server
21+
22+
Free public server comes with absolutely shitty availability.
23+
24+
1. Install the [Codenotify](https://github.com/apps/codenotify) GitHub App on your repositories.
25+
2. Add some [CODENOTIFY files](https://github.com/sourcegraph/codenotify#codenotify-files).
26+
27+
### Run your own server
28+
29+
Docker images for the Codenotify.run server are available both on [Docker Hub](https://hub.docker.com/r/unknwon/codenotify.run) and [GitHub Container Registry](https://github.com/codenotify/codenotify.run/pkgs/container/codenotify.run).
30+
31+
> **Note**
32+
> The `latest` tag represents the latest build from the `main` branch.
33+
34+
You need to create a `custom` directory for the configuration file `app.ini`:
35+
36+
```bash
37+
$ mkdir -p custom/conf
38+
$ touch custom/conf/app.ini
39+
```
40+
41+
Please refer to [Local development > Step 2: Create a test GitHub App](#step-2-create-a-test-github-app) for creating a GitHub App, setting up a reverse proxy and filling out necessary configuration options.
42+
43+
> **Note**
44+
> The [Caddy web server](https://caddyserver.com/) is recommended for production use with automatic HTTPS.
45+
46+
Then volume the `custom` directory into the Docker container for it being able to start (`/app/codenotify.run/custom` is the path inside the container):
47+
48+
```bash
49+
$ docker run \
50+
--name=codenotify.run \
51+
-p 12830:2830 \
52+
-v $(pwd)/custom:/app/codenotify.run/custom \
53+
unknwon/codenotify.run
54+
```
2155

2256
## Local development
2357

0 commit comments

Comments
 (0)