Merge pull request #53 from nichwall/master

Updated library creation guide for 2.4.5
audiobookshelf · Oct 29, 2023 · d835245 · d835245
2 parents 5c58e8a + 5718de0
commit d835245
Show file tree

Hide file tree

Showing 22 changed files with 58 additions and 17 deletions.
diff --git a/content/guides/10.rss_feeds.md b/content/guides/10.rss_feeds.md
@@ -0,0 +1,42 @@
+---
+title: RSS Feeds
+slug: rss_feeds
+fullpath: /guides/rss_feeds
+---
+
+---
+
+# Introduction
+
+This guide discusses the RSS Manager in the server settings.
+
+These RSS feeds are *not* the same as the RSS feeds that are used to automatically download new podcast episodes.
+
+# Creating RSS Feeds
+
+Audiobookshelf allows admins to host audio content from the server through an RSS feed. The following types can be hosted using an RSS feed:
+- Library items
+- Collections
+- Podcasts
+
+Playlists cannot have an associated RSS feed because they are account specific.
+
+To create an RSS feed, select "Open RSS Feed" in the 3-dot dropdown menu.
+![Open the feed](/guides/rss_feeds/open_feed.jpg)
+
+You can then change some settings for the RSS feed that you will be hosting. You can set the slug (defaults to the library item ID), whether to prevent the RSS feed from being indexed by web services, and a custom owner name and email.
+
+The URL is created based on how you are accessing your ABS server at the time you create the RSS feed (outlined in red). If you are connected to your local IP, then the RSS feed will only be accessible on your local IP. If you connect using your public domain name, the URL will be set up to use the domain name.
+![Feed settings](/guides/rss_feeds/feed_menu.jpg)
+
+You can copy the link displayed in the confirmation modal. You can click anywhere off of the modal to continue using ABS.
+![Confirmation modal](/guides/rss_feeds/confirmation.jpg)
+
+# Managing Open RSS Feeds
+From the settings, you can access the open RSS Feeds.
+The table shows you what audiobooks, collections, and podcasts are currently available through RSS feeds.
+Clicking on a row allows an admin to copy the RSS URL for sharing.
+Open feeds can be closed from this table as well.
+
+![RSS Feed Manager](/guides/rss_feeds/feed_manager.jpg)
+
diff --git a/content/guides/2.library_creation.md b/content/guides/2.library_creation.md
@@ -9,28 +9,27 @@ fullpath: /guides/library_creation
 # Introduction
 This guide will help you to create a library in ABS. This guide assumes you have correctly configured your installation.
 
-Screenshots are from an install of v2.2.0 in Docker, but remain mostly unchanged in v2.3.3.
+NOTE: If you are using docker, make sure your mounts are set up correctly. If they are not set up correctly, you will lose data at some point in the future. The easiest way to check if they are set up correctly is to add a book to the library and ensure that it shows up in your file system. 
+
+Still confused about Docker? Check out [this FAQ](/faq#im-still-confused-about-what-docker-and-containers-are-and-how-they-work)
 
 # Setting up a library
 
 ABS supports two kinds of libraries: book and podcast. Both kinds of library allow individual items to be added to the library. A podcast library can also download new episodes from an RSS feed automatically.
-To create a library file in ABS:
-* Create a library directory for either [audiobooks](https://www.audiobookshelf.org/docs#book-structure) or [podcasts](https://www.audiobookshelf.org/docs#podcast-structure)
-* Go to (1) Settings -> (2) Library -> (3) Add Library. This installation already has two libraries set up (named "Audible" and "Podcasts")
-![Add library](/guides/library_setup/add_library.png)
-* Set library paths. You can either type the path manually or Browse for Folder. If you have multiple directories where books/podcasts are stored, you can add multiple paths to the library. NOTE: There are issues with the "Browse for Folder" button on some systems, so you may need to enter the path manually if the button is not working.
+To create a library in ABS:
+* Create a library directory for either [audiobooks](/docs#book-structure) or [podcasts](/docs#podcast-structure)
+* Go to (1) Settings -> (2) Library -> (3) Add Library.
+![Add library](/guides/library_setup/add_library.jpg)
+* Set library paths. You can either type the path manually or Browse for Folder. If you have multiple directories where books/podcasts are stored, you can add multiple paths to the library. You can have multiple paths in the same library. If you are using docker, you should be using the path within the docker container, not the path in your normal file system. NOTE: For installs that are not using Docker the folder path will need to be entered manually, the "Browse for Folder" button is a work-in-progress for non-Docker installs.
 ![Add paths](/guides/library_setup/initial_library_creation.gif)
-* Modify library settings (you can edit these later)
-![Edit settings](/guides/library_setup/details_4.png)
-* You can also set a schedule to rescan the library for new books or changes. This periodic scan is disabled by default.
-![Periodic scan](/guides/library_setup/schedule_scan.png)
-* Once you have created the library, you should see something like this.
-![Newly created view](/guides/library_setup/before_scanning.png)
-* You can create more libraries to either divide books or add podcasts. If you have multiple libraries, you can switch between them using the button in red. I went ahead and created a podcast library to demonstrate this.
-![Added podcasts to switch libraries](/guides/library_setup/switching_libraries.png)
-* Now that the library is created, you can scan the library to have books added to the library. You can either do this from the home screen or the settings page. NOTE: this view has changed slightly, with the buttons being located in the dropdown menu of 3 vertical dots.
-![Scan from settings](/guides/library_setup/before_scan_settings.png)
-![Initial library scan from home](/guides/library_setup/scan_library.gif)
+* Modify library settings (you can set this up now or edit the settings later)
+![Edit settings](/guides/library_setup/settings.jpg)
+* You can also set a schedule to rescan the library for new books or changes. This periodic scan is disabled by default. NOTE: This should not be necessary if the watcher is enabled and working because changes to your folders are detected and scanned automatically.
+![Periodic scan](/guides/library_setup/schedule_scan.jpg)
+* After creating the library, you can scan for items within the library using the "Scan" button or use the dropdown to scan. The library settings can be adjusted from here as well. Additional information on the scanner can be found [here](/guides/book-scanner).
+![Periodic scan](/guides/library_setup/scan_and_dropdown.jpg)
+* You can create more libraries to either divide books or add podcasts. If you have multiple libraries, you can switch between them using the button circled in red.
+![Added podcasts to switch libraries](/guides/library_setup/switching_libraries.jpg)
 
 # Conclusion
 You should now have a functioning library!

diff --git a/static/guides/library_setup/add_library.jpg b/static/guides/library_setup/add_library.jpg
diff --git a/static/guides/library_setup/add_library.png b/static/guides/library_setup/add_library.png
diff --git a/static/guides/library_setup/before_scan_settings.png b/static/guides/library_setup/before_scan_settings.png
diff --git a/static/guides/library_setup/before_scanning.png b/static/guides/library_setup/before_scanning.png
diff --git a/static/guides/library_setup/details_1.png b/static/guides/library_setup/details_1.png
diff --git a/static/guides/library_setup/details_2.png b/static/guides/library_setup/details_2.png
diff --git a/static/guides/library_setup/details_3.png b/static/guides/library_setup/details_3.png
diff --git a/static/guides/library_setup/details_4.png b/static/guides/library_setup/details_4.png
diff --git a/static/guides/library_setup/remove_metadata.jpg b/static/guides/library_setup/remove_metadata.jpg
diff --git a/static/guides/library_setup/scan_and_dropdown.jpg b/static/guides/library_setup/scan_and_dropdown.jpg
diff --git a/static/guides/library_setup/scanner_priority.jpg b/static/guides/library_setup/scanner_priority.jpg
diff --git a/static/guides/library_setup/schedule_scan.jpg b/static/guides/library_setup/schedule_scan.jpg
diff --git a/static/guides/library_setup/schedule_scan.png b/static/guides/library_setup/schedule_scan.png
diff --git a/static/guides/library_setup/settings.jpg b/static/guides/library_setup/settings.jpg
diff --git a/static/guides/library_setup/switching_libraries.jpg b/static/guides/library_setup/switching_libraries.jpg
diff --git a/static/guides/library_setup/switching_libraries.png b/static/guides/library_setup/switching_libraries.png
diff --git a/static/guides/rss_feeds/confirmation.jpg b/static/guides/rss_feeds/confirmation.jpg
diff --git a/static/guides/rss_feeds/feed_manager.jpg b/static/guides/rss_feeds/feed_manager.jpg
diff --git a/static/guides/rss_feeds/feed_menu.jpg b/static/guides/rss_feeds/feed_menu.jpg
diff --git a/static/guides/rss_feeds/open_feed.jpg b/static/guides/rss_feeds/open_feed.jpg