Skip to content

Commit

Permalink
Merge pull request #6 from retrowars/remove-heroku
Browse files Browse the repository at this point in the history
Remove heroku server and update docs to reference docker.
  • Loading branch information
pserwylo authored Jul 3, 2023
2 parents beec2b7 + 2be9d27 commit 67b0807
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 13 deletions.
46 changes: 34 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,40 @@ The [retrowars game](https://github.com/retrowars/retrowars) queries this JSON f

Retrowars is a community driven project. We will try to make sure that there are servers run by the maintainers, but it would also be wonderful if others who enjoy the game and have the skills/resources were able to contribute a server to the pool of publicly available servers.

#### Using Docker

The latest server image can be pulled from [`pserwylo/retrowars` on Dockerhub](`https://hub.docker.com/r/pserwylo/retrowars`).

Here is an example docker-compose file you could use:

```
version: '3.1'
services:
your-retrowars-server.com:
image: pserwylo/retrowars:latest
expose:
- 80
environment:
- PORT=80
# Example configuration options:
- MAX_ROOMS=10
- ROOM_SIZE=4
- FINAL_SCORE_DURATION=7500
# volumes:
# If you want to customise the logging format:
# - ./logback.xml:/etc/retrowars/logback.xml
# If you want to retain logs:
# - retrowars-latest-logs:/var/log/retrowars/
```

#### Using the portable executable .jar file

Obtaining a `.jar` file by either:
Expand Down Expand Up @@ -84,18 +118,6 @@ server {
}
```

#### Using Heroku

The server is designed so that it can be easily deployed to a Heroku instance. Indeed the [retrowars1.serwylo.com](http://retrowars1.serwylo.com/info) server is hosted on a free Heroku dyno (hence why it takes approx 20 seconds to respond if it hasn't been used in a while and has begun idling).

To do so, you can:
* Clone the main retrowars project at http://github.com/retrowars/retrowars
* [Add a Heroku remote to the cloned repository](https://devcenter.heroku.com/articles/git#creating-a-heroku-remote)
* [Deploy the app via git](https://devcenter.heroku.com/articles/git#deploying-code)

This will result in Heroku building the app and running it for you. From there, you may wish to also:
* [Add a custom domain](https://devcenter.heroku.com/articles/custom-domains)

### Maintaining this list

#### Adding servers
Expand Down
1 change: 0 additions & 1 deletion docs/.well-known/com.serwylo.retrowars-servers.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@
{"hostname": "retrowars-latest.serwylo.com", "port": 80},
{"hostname": "retrowars.azlux.fr", "port": 80},
{"hostname": "retrowars1.serwylo.com", "port": 80},
{"hostname": "retrowars2.serwylo.com", "port": 80},
{"hostname": "rwr.nekoweb.my.id", "port": 80}
]

0 comments on commit 67b0807

Please sign in to comment.