Document config, start collection setup page

Timothy Warren 2017-02-21 14:59:21 -05:00
parent ce4b0bf76b
commit 508853ee7a
3 changed files with 28 additions and 1 deletions

5
collection.md Normal file

@ -0,0 +1,5 @@
# Anime Collection Setup
Because the anime collection can use more than one type of database, the setup
is a bit more complex than other features to setup.

@ -15,7 +15,28 @@ Cache setup
### config.toml
General configuration
* **kitsu_username** - The username for your account on [Kitsu](https://kitsu.io)
* **whose_list** - Name to show in the header
* **show_anime_collection** - Whether to show the collection in the main menu
* **use_mal_api** - Whether to use the MyAnimeList API. Make sure to have it setup in `mal.toml` beforehand.
* **asset_dir** - The path to the public directory. Normally you won't need to edit this
### database.toml
Anime Collection Database Setup
* **[collection]**
* **type** - database that you are using, one of: `mysql`, `pgsql`, or `sqlite`
* **host** - hostname to use to connect to the database, not needed for `sqlite`
* **user** - username to connect to database, not needed for `sqlite`
* **pass** - password to connect to database, not needed for `sqlite`
* **port** - port to connect to database, only needed if using a non-default database port
* **database** - the specific database to connect to, not needed for `sqlite`
* **file** - `sqlite` only: the database file to use
### mal.toml
Settings for using the MyAnimeList.net API
Settings for using the [MyAnimeList.net](https://myanimelist.net) API
* **username** - [MAL](https://myanimelist.net) username
* **password** - [MAL](https://myanimelist.net) password

@ -4,4 +4,5 @@ Here is some more in-depth information about setting up Hummingbird.
## Pages
* [Collection Setup](./collection) - how to set up the Anime collection
* [Configuration](./configuration)