docs: Add pikapods.com as installation option (#676)

* Add pikapods.com as install option * Include info about the pricing and the initial credit * Fix typo in docs --------- Co-authored-by: Mohamed Bassem <[email protected]>
hoarder-app · Nov 23, 2024 · df19d39 · df19d39
1 parent dcba3c4
commit df19d39
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/docs/docs/02-Installation/05-pikapods.md b/docs/docs/02-Installation/05-pikapods.md
@@ -0,0 +1,28 @@
+# PikaPods [Paid Hosting]
+
+[PikaPods](https://www.pikapods.com/) offers managed paid hosting for many open source apps, including Hoarder.
+Server administration, updates, migrations and backups are all taken care of, which makes it well suited
+for less technical users. As of Nov 2024, running Hoarder there will cost you ~$3 per month.
+
+### Requirements
+
+- A _PikaPods_ account. Can be created for free [here](https://www.pikapods.com/register). You get an initial welcome credit of $5.
+
+### 1. Choose app
+
+Choose _Hoarder_ from their [list of apps](https://www.pikapods.com/apps) or use this [direct link](https://www.pikapods.com/pods?run=hoarder). This will either
+open a new dialog to add a new _Hoarder_ pod or ask you to log in.
+
+### 2. Add settings
+
+There are a few settings to configure in the dialog:
+
+- **Basics**: Give the pod a name and choose a region that's near you.
+- **Env Vars**: Here you can disable signups or set an OpenAI API key. All settings are optional.
+- **Resources**: The resources your _Hoarder_ pod can use. The defaults are fine, unless you have a very large collection.
+
+### 3. Start pod and add user
+
+After hitting _Add pod_ it will take about a minute for the app to fully start. After this you can visit
+the pod's URL and add an initial user under _Sign Up_. After this you may want to disable further sign-ups
+by setting the pod's `DISABLE_SIGNUPS` _Env Var_ to `true`.