audiobookshelf warning and formatting improvements

This commit is contained in:
2026-01-24 21:23:08 -07:00
parent b4711953bc
commit cfee6f7302
6 changed files with 27 additions and 7 deletions
+12 -1
View File
@@ -1,4 +1,15 @@
# Audiobookshelf # Audiobookshelf
**WARNING**: Audiobookshelf takes an extremely long time to be ready for
connections, with no indication of when it will be ready. You will get
continuous 502 Bad Gateway errors until it resolves.
Modified from official instructions: https://www.audiobookshelf.org/docs/#docker-compose-install Modified from official instructions: https://www.audiobookshelf.org/docs/#docker-compose-install
**WARNING**: If you ever accidentally leave an old version of an Audiobookshelf database where a new version can see it, a restart may cause it to load the old database, and **its default behavior when this occurs is to delete every file it doesn't recognize**. Thankfully, I had backups, but I have to set up all of the metadata around this all over again now. During initial setup, you will be asked to create a library. I just call it
"Books", use `/audiobooks` for the path, and leave everything else at default.
**WARNING**: If you ever accidentally leave an old version of an Audiobookshelf
database where a new version can see it, a restart may cause it to load the old
database, and **its default behavior when this occurs is to delete every file it
doesn't recognize**. Thankfully, I had backups, but I have to set up all of the
metadata around this all over again now.
+4
View File
@@ -1,6 +1,10 @@
# TODO set volume directories # TODO set volume directories
# TODO set timezone (TZ) # TODO set timezone (TZ)
# WARNING Audiobookshelf takes an extremely long time to be ready for
# connections, with no indication of when it will be ready. You will get
# continuous 502 Bad Gateway errors until it resolves.
volumes: volumes:
audiobooks: audiobooks:
driver: local driver: local
+4 -3
View File
@@ -1,7 +1,8 @@
# Cosmos Cloud # Cosmos Cloud
**WARNING**: A database is set up by the UI using a volume instead of a bind mount, **WARNING**: A database is set up by the UI using a volume instead of a bind
so this setup is ***not*** self-contained. mount, so this setup is ***not*** self-contained.
Host mode networking needs to be explicitly enabled in Docker Desktop on macOS. Host mode networking needs to be explicitly enabled in Docker Desktop on macOS.
Newer docker compose versions will complain about the `version` directive, but it is kept for backwards compatibility. Newer docker compose versions will complain about the `version` directive, but
it is kept for backwards compatibility.
+2 -1
View File
@@ -5,7 +5,8 @@ WARNING: Does not work with docker-compose.
1. Edit `docker-compose.yml` to set directories and a database password. 1. Edit `docker-compose.yml` to set directories and a database password.
2. Create directories needed: library, database, model-cache 2. Create directories needed: library, database, model-cache
3. Run docker compose, create admin account, change instance settings before uploading! 3. Run docker compose, create admin account, change instance settings before
uploading!
## Major Version Upgrades / Breaking Changes ## Major Version Upgrades / Breaking Changes
Check the official docs: https://docs.immich.app/install/upgrading/ Check the official docs: https://docs.immich.app/install/upgrading/
+2 -1
View File
@@ -5,6 +5,7 @@ Modified from official instructions: https://docs.joinpeertube.org/install/docke
2. Generate `PEERTUBE_SECRET` using `openssl rand -hex 32`. 2. Generate `PEERTUBE_SECRET` using `openssl rand -hex 32`.
3. Create the volume directories needed: config, data, opendkim, postgres, redis 3. Create the volume directories needed: config, data, opendkim, postgres, redis
4. Launch from CLI docker compose. 4. Launch from CLI docker compose.
5. Search logs for "User password" (near the end) to find the generated password for the root account. 5. Search logs for "User password" (near the end) to find the generated password
for the root account.
Be careful setting up the instance initially. It's not as easy as it seems. Be careful setting up the instance initially. It's not as easy as it seems.
+3 -1
View File
@@ -1,5 +1,7 @@
# Vikunja # Vikunja
**WARNING**: This software is brand new and cannot handle a power failure. I'm probably going to stop using it because of that. I don't want to have to manually recover everything any time there is an uncontrollable issue like this. **WARNING**: After a power failure, permissions were reset on the volume this
app was using, causing it to fail. I have no idea how that occurred. Permissions
must be user/group 1000 for this to function.
1. [What to backup](https://vikunja.io/docs/what-to-backup/) 1. [What to backup](https://vikunja.io/docs/what-to-backup/)
2. [Configuration options](https://vikunja.io/docs/config-options/) 2. [Configuration options](https://vikunja.io/docs/config-options/)