From a0e053b0b2e206130cfc1b32649bb6ffa9bfe7ba Mon Sep 17 00:00:00 2001
From: Anarion Dunedain <anarion80@gmail.com>
Date: Tue, 28 Mar 2023 14:01:27 +0200
Subject: [PATCH] Duplicate
 website/docs/applications/media-serving/ubooquity.md history in
 roles/ubooquity/docs/ history.

---
 roles/ubooquity/docs/ubooquity.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 roles/ubooquity/docs/ubooquity.md

diff --git a/roles/ubooquity/docs/ubooquity.md b/roles/ubooquity/docs/ubooquity.md
new file mode 100644
index 00000000..1dea7806
--- /dev/null
+++ b/roles/ubooquity/docs/ubooquity.md
@@ -0,0 +1,27 @@
+---
+title: "Ubooquity"
+---
+
+Homepage: <https://vaemendis.net/ubooquity/>
+
+Documentation: <https://vaemendis.github.io/ubooquity-doc/>
+
+Docker Image: <https://hub.docker.com/r/linuxserver/ubooquity/>
+
+Ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer.
+
+## Usage
+
+Set `ubooquity_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
+
+Access the webui at <http://ansible_nas_host_or_ip:2202/ubooquity> by default. See specific configuration section below for information on setting up external access.
+
+## Specific Configuration
+
+Important note: if you want to access Ubooquity externally through Traefik (at ubooquity.yourdomain.tld), you need to go to <http://ansible_nas_host_or_ip:2203/ubooquity/admin> and set the reverse proxy prefix to blank under "Advanced". Otherwise you will need to append "/ubooquity" to the url in order to access.
+
+### Admin login
+
+The admin portal is not exposed through Traefik. You can access the admin portal on port 2203.
+
+Upon your first run, the address is <http://ansible_nas_host_or_ip:2203/ubooquity/admin>. You will be able to set the admin password here.