Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
serebit committed May 11, 2021
1 parent d0f73c6 commit 107c515
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Spyglass

[![Streamcord (Closed Beta)][streamcord-badge]](https://streamcord.io/twitch/)
[![Docker Version][docker-badge]](https://hub.docker.com/repository/docker/serebit/spyglass)
[![Discord][discord-guild-badge]](https://discord.com/invite/UNYzJqV)
[![Boost License 1.0][github-license-badge]](https://www.boost.org/users/license.html)

Expand All @@ -20,7 +21,8 @@ First, install a JDK, version 11 or greater. Then:
$ ./gradlew docker
```

This will build Spyglass from scratch and create a Docker container named `spyglass` with a corresponding version.
This will build Spyglass from scratch and create a Docker container named `serebit/spyglass` with a corresponding
version.

## Setup

Expand Down Expand Up @@ -151,7 +153,7 @@ $ sudo docker run \
--env SPYGLASS_WORKER_TOTAL=1 \
--env SPYGLASS_WORKER_CALLBACK=eventsub.streamcord.io \
--volume "/PATH/TO/spyglass.yml:/var/app/spyglass.yml" \
spyglass:VERSION
serebit/spyglass:VERSION
```

You may need to set up additional environment variables to enable use of a reverse proxy or other local setups. For
Expand All @@ -170,7 +172,7 @@ $ sudo docker run \
--expose 8080 \
--volume "/PATH/TO/spyglass.yml:/var/app/spyglass.yml" \
--network <NAME_OF_DOCKER_NETWORK> \
spyglass:1.0.0-SNAPSHOT
serebit/spyglass:VERSION
```

In this case, the nginx-proxy container would need access to the named docker network as well in order to redirect
Expand All @@ -197,6 +199,8 @@ Distributed under the Boost Software License, Version 1.0.

[streamcord-badge]: https://img.shields.io/badge/Streamcord-Closed_Beta-9146ff

[docker-badge]: https://img.shields.io/docker/v/serebit/spyglass?label=docker%20version&sort=date

[discord-guild-badge]: https://discordapp.com/api/guilds/294215057129340938/widget.png?style=shield "Discord Server"

[github-license-badge]: https://img.shields.io/github/license/streamcord/spyglass?color=lightgrey

0 comments on commit 107c515

Please sign in to comment.