Skip to content

Commit

Permalink
README: add docs for Docker
Browse files Browse the repository at this point in the history
  • Loading branch information
unknwon committed Oct 7, 2022
1 parent ebd8945 commit 2b44dc6
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,41 @@ Using a personal access token would of course solve the first problem, but a per

## How?

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).
### Free public server

Free public server comes with absolutely shitty availability.

1. Install the [Codenotify](https://github.com/apps/codenotify) GitHub App on your repositories.
2. Add some [CODENOTIFY files](https://github.com/sourcegraph/codenotify#codenotify-files).

### Run your own server

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).

> **Note**
> The `latest` tag represents the latest build from the `main` branch.
You need to create a `custom` directory for the configuration file `app.ini`:

```bash
$ mkdir -p custom/conf
$ touch custom/conf/app.ini
```

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.

> **Note**
> The [Caddy web server](https://caddyserver.com/) is recommended for production use with automatic HTTPS.
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):

```bash
$ docker run \
--name=codenotify.run \
-p 12830:2830 \
-v $(pwd)/custom:/app/codenotify.run/custom \
unknwon/codenotify.run
```

## Local development

Expand Down

2 comments on commit 2b44dc6

@dirgam92
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__

@dirgam92
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#8

Please sign in to comment.