aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.30.0/02-installation/10-pikapods.md
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2026-01-01 10:58:22 +0000
committerMohamed Bassem <me@mbassem.com>2026-01-01 10:58:22 +0000
commit4b54eeec0ebdd60d28ce865d56e079c4d11384ae (patch)
tree8180003c92358d74a9796b48d3fd341fae8f8338 /docs/versioned_docs/version-v0.30.0/02-installation/10-pikapods.md
parentd472a3a1c428bad8ce2ddc0822fb5b327e9465d4 (diff)
downloadkarakeep-4b54eeec0ebdd60d28ce865d56e079c4d11384ae.tar.zst
release(docs): release the 0.30 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.30.0/02-installation/10-pikapods.md')
-rw-r--r--docs/versioned_docs/version-v0.30.0/02-installation/10-pikapods.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.30.0/02-installation/10-pikapods.md b/docs/versioned_docs/version-v0.30.0/02-installation/10-pikapods.md
new file mode 100644
index 00000000..290e5819
--- /dev/null
+++ b/docs/versioned_docs/version-v0.30.0/02-installation/10-pikapods.md
@@ -0,0 +1,32 @@
+# PikaPods
+
+:::info
+Note: PikaPods shares some of its revenue from hosting Karakeep with the maintainer of this project.
+:::
+
+[PikaPods](https://www.pikapods.com/) offers managed paid hosting for many open source apps, including Karakeep.
+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 Karakeep 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 _Karakeep_ 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 _Karakeep_ 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 _Karakeep_ 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`.