From 508853ee7a79323b07fc88d023558fde3b96d648 Mon Sep 17 00:00:00 2001 From: Timothy J Warren Date: Tue, 21 Feb 2017 14:59:21 -0500 Subject: [PATCH] Document config, start collection setup page --- collection.md | 5 +++++ configuration.md | 23 ++++++++++++++++++++++- home.md | 1 + 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 collection.md diff --git a/collection.md b/collection.md new file mode 100644 index 0000000..7862e23 --- /dev/null +++ b/collection.md @@ -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. + diff --git a/configuration.md b/configuration.md index 14a1abf..8ea4853 100644 --- a/configuration.md +++ b/configuration.md @@ -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 \ No newline at end of file +Settings for using the [MyAnimeList.net](https://myanimelist.net) API + +* **username** - [MAL](https://myanimelist.net) username +* **password** - [MAL](https://myanimelist.net) password \ No newline at end of file diff --git a/home.md b/home.md index b9b3331..4ae4c54 100644 --- a/home.md +++ b/home.md @@ -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) \ No newline at end of file