02 Getting Started

I currently do not provide a global authentication server or similar, therefore setting up third-party services needs to be done by everyone using tierrating.

All redirect urls follow the same pattern: https://<your.domain.com>/auth/<service>

If you are using a local deployment and no reverse proxy make sure to use the url to the webapp for any redirect urls.

AniList

1. Login to your AniList account
2. Go to settings > Developer
3. Create a new client
   • Name: Tierlist
   • Redirect URL: https://tierlist.example.com/auth/anilist
4. Update the environment variables in the docker-compose.yml
   • ANILIST_CLIENT_ID
   • ANILIST_CLIENT_SECRET
   • ANILIST_REDIRECT_URL

Trakt

1. Login to your Trakt account
2. Go to settings and select "Your API Apps"
3. Create a new client
   • Name: Tierlist
   • Redirect URL: https://tierlist.example.com/auth/trakt
4. Update the environment variables in the docker-compose.yml
   • TRAKT_CLIENT_ID
   • TRAKT_CLIENT_SECRET
   • TRAKT_REDIRECT_URL

Furthermore, Trakt needs access to TMDB API for all covers.

TODO: TMDB API guide

Steam

TODO: Steam API guide