Updates readme
This commit is contained in:
soneill
parent
00dc6ed5f3
commit
e5a261ee30
3 changed files with 138 additions and 13 deletions
142
README.md
142
README.md
|
|
@ -1,13 +1,141 @@
|
|||
# Pathfinder Container
|
||||
Private fork of techfreak's [Pathfinder-container](https://gitlab.com/techfreak/pathfinder-container/) docker-compose solution for Pathfinder using caddy2
|
||||
# Pathfinder Containers
|
||||
A fork of techfreak's [Pathfinder-container](https://gitlab.com/techfreak/pathfinder-container/) docker-compose solution for Pathfinder that is designed to work with Goryn Clade's [Pathfinder](https://github.com/goryn-clade/pathfinder/) fork, using [Traefik](https://traefik.io/) as a reverse proxy to expose the docker container.
|
||||
|
||||
### Acknowledgments
|
||||
1. [Installation](#installation)
|
||||
1. [Using Traefik](#using-traefik)
|
||||
1. [Development](#development)
|
||||
|
||||
## Installation
|
||||
|
||||
**Prerequisites**:
|
||||
* [docker](https://docs.docker.com/)
|
||||
* [docker-compose](https://docs.docker.com/)
|
||||
|
||||
> **Note**: The Docker-compose file uses Compose v3.8, so requires Docker Engine 19.03.0+
|
||||
|
||||
</br>
|
||||
|
||||
|
||||
1. **Create an API-Key**
|
||||
* Go the [Eve Online Developer portal](https://developers.eveonline.com/)
|
||||
* After signing in go to "MANAGE APPLICATIONS" → "CREATE NEW APPLICATION"
|
||||
* Choose a name for your application (e.g. "Pathfinder Production")
|
||||
* Enter a Description for this installation
|
||||
* Change "CONNECTION TYPE" to "Authentication & API Access"
|
||||
* Add the following "PERMISSIONS":
|
||||
* `esi-location.read_online.v1`
|
||||
* `esi-location.read_location.v1`
|
||||
* `esi-location.read_ship_type.v1`
|
||||
* `esi-ui.write_waypoint.v1`
|
||||
* `esi-ui.open_window.v1`
|
||||
* `esi-universe.read_structures.v1`
|
||||
* `esi-corporations.read_corporation_membership.v1`
|
||||
* `esi-clones.read_clones.v1`
|
||||
* `esi-characters.read_corporation_roles.v1`
|
||||
* Set your "CALLBACK URL" to `https://[YOUR_DOMAIN]/sso/callbackAuthorization`</br></br>
|
||||
|
||||
|
||||
1. **Clone the repo**
|
||||
```shell
|
||||
git clone --recurse-submodules git@github.com:goryn-clade/pathfinder-containers.git
|
||||
```
|
||||
|
||||
1. **Edit the *.env* file and make sure every config option has an entry.**
|
||||
```shell
|
||||
PATH="" # The path of the cloned repo
|
||||
CONTAINER_NAME="pf" # docker container name prefix
|
||||
DOMAIN="" # The domain you will be using
|
||||
APP_PASSWORD="" # Password for /setup
|
||||
MYSQL_PASSWORD="" # Mysql Password
|
||||
CCP_SSO_CLIENT_ID="" # Use the SSO tokens created in step 1
|
||||
CCP_SSO_SECRET_KEY=""
|
||||
CCP_ESI_SCOPES="esi-location.read_online.v1,esi-location.read_location.v1,esi-location.read_ship_type.v1,esi-ui.write_waypoint.v1,esi-ui.open_window.v1,esi-universe.read_structures.v1,esi-corporations.read_corporation_membership.v1,esi-clones.read_clones.v1,esi-characters.read_corporation_roles.v1"
|
||||
|
||||
1. **Edit the *config/pathfinder/pathfinder.ini*** to your liking
|
||||
|
||||
Recommended options to change:
|
||||
* `[PATHFINDER]`
|
||||
* `NAME`- the name tab title when viewing your Pathfinder
|
||||
* `[PATHFINDER.LOGIN]`
|
||||
* `COOKIE_EXPIRE` - expire age (in days) for login cookies. [read more](https://github.com/exodus4d/pathfinder/issues/138#issuecomment-216036606)
|
||||
* `SESSION_SHARING` - Share maps between logged in characters in the same browser session. [read more](https://github.com/goryn-clade/pathfinder/releases/tag/v2.1.1)
|
||||
* `CHARACTER` - Character allow-list. Comma separated string of character ids. (empty = "no restriction")
|
||||
* `CORPORATION` - Corporation allow-list. Comma separated string of corporation ids. (empty = "no restriction")
|
||||
* `ALLIANCE` - Alliance allow-list. Comma separated string of alliance ids. (empty = "no restriction")
|
||||
* `[PATHFINDER.MAP.PRIVATE]`, `[PATHFINDER.MAP.PRIVATE]`, `[PATHFINDER.MAP.ALLIANCE]`
|
||||
* `LIFETIME` - expire time (in days) until a map type will be deleted (by cronjob)
|
||||
</br></br>
|
||||
|
||||
|
||||
1. **Build & Run it**
|
||||
```shell
|
||||
docker network create web && docker-compose up -- build
|
||||
```
|
||||
|
||||
1. **Open the http://< your-domain >/setup page.**
|
||||
* Your username is pf and password is the password you set in APP_PASSWORD.
|
||||
* Click on create database for eve_universe and pathfinder. And click on setup tables && fix column/keys.
|
||||
</br></br>
|
||||
|
||||
1. **Go back to your console and insert the eve universe dump with this command:**
|
||||
```shell
|
||||
docker-compose exec pfdb /bin/sh -c "unzip -p eve_universe.sql.zip | mysql -u root -p\$MYSQL_ROOT_PASSWORD eve_universe";
|
||||
|
||||
1. **When everthing works, configure Traefik correctly for production**
|
||||
* Remove the beta CA server lines (#87 - #90) from `docker-compose.yml`.
|
||||
* Delete the `letsencrypt/acme.json` configuration file so Let's Encrypt will get a new certificate.</br></br>
|
||||
|
||||
|
||||
> Hint: If you need to make changes, perform your edits first, then do `docker-compose down` to bring down the project, and then `docker-compose up --build -d` to rebuild the containers and run them again.
|
||||
|
||||
</br>
|
||||
|
||||
---
|
||||
</br>
|
||||
|
||||
### Using Traefik
|
||||
|
||||
To keep things simple, the structure of this project assumes that you will use Traefik to provide access to your Pathfinder docker container and nothing else. As such, Traefik containers start and stop with the Pathfinder containers.
|
||||
|
||||
If you want to run other services in docker on the same host that also need to be exposed to the web, you should strongly consider splitting Traefik into a separate project with its own docker-compose file. This will allow you to take pathfinder project offline for maintenance without affecting other containers that rely on Traefik.
|
||||
|
||||
</br>
|
||||
|
||||
---
|
||||
|
||||
</br>
|
||||
|
||||
## Development
|
||||
|
||||
Some Development configurations that have worked well for me have been saved in the `development/` directory, including step debugging for VsCode using [xdebug](https://xdebug.org/)
|
||||
|
||||
Development configs and docker files can be quickly restored using:
|
||||
|
||||
|
||||
```shell
|
||||
chmod +x ./development/development.sh && ./development/development.sh
|
||||
```
|
||||
|
||||
This creates a partial `.env` file, but you will need to add your CCP SSO client and keys manually.
|
||||
|
||||
It's best to create a new SSO application for development work, so that you can set the callback url to `https://localhost/sso/callbackAuthorization`.
|
||||
|
||||
</br>
|
||||
|
||||
---
|
||||
|
||||
</br>
|
||||
|
||||
## Acknowledgments
|
||||
* [exodus4d](https://github.com/exodus4d/) for pathfinder
|
||||
* [Markus Geiger](https://gist.github.com/blurayne/f63c5a8521c0eeab8e9afd8baa45c65e) for his awesome bash menu
|
||||
* [techfreak](https://gitlab.com/techfreak/pathfinder-container) for the original Pathfinder-container project
|
||||
* [johnschultz](https://gitlab.com/johnschultz/pathfinder-container/) for improvements to the traefik config
|
||||
|
||||
### Authors
|
||||
* [techfreak](https://gitlab.com/techfreak)
|
||||
## Authors
|
||||
* techfreak
|
||||
* johnschultz
|
||||
* samoneilll
|
||||
|
||||
### License
|
||||
## License
|
||||
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue