tomekwojcik/hotpocket
1
0
Fork 0
Code Actions Releases 16 Wiki Activity

Add Getting Started

Tomek Wójcik
2025-11-25 11:05:19 +00:00
commit ae580741b7
1 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Getting-Started.md Normal file

@@ -0,0 +1,29 @@
# Getting Started with HotPocket
This document provides instructions for setting up HotPocket, so you can start saving your links.
HotPocket's main UI is the Web Application. At the time of writing, there are no known public instances of HotPocket. You'll need to set one up yourself. See below for information to get you started.
## Setting up the Web Application
HotPocket is designed for self-hosting. It supports almost any kind of environment - from one-container setups on a single node to full-stack setups.
The Web application (also known as HotPocket Backend) is packages as a Docker images. They're available publicly on Docker Hub - [bthlabs/hotpocket](https://hub.docker.com/r/bthlabs/hotpocket). The images support `linux/amd64` and `linux/arm64` architectures.
There are two modes of the Docker image - `aio` and `deployment`. The `aio` image is suitable for small setups, with a few users. The `deployment` image is designed for full-stack setups. Both modes are compatible with Docker Compose, Kubernetes and other container runtimes.
Docker images are tagged and pushed on release.
The documentation on Docker Hub provides extensive description of the images. It also provides links to example setups in the project's repository.
## Available apps and extensions
HotPocket provides the following apps and extensions to make your time saving links easier:
* Official iOS, iPadOS and macOS companion apps for Safari and Share extensions - [HotPocket by BTHLabs](https://apps.apple.com/pl/app/hotpocket-by-bthlabs/id6752321380).
* Official extension for Firefox - [Save to HotPocket](https://addons.mozilla.org/en-GB/firefox/addon/save-to-hotpocket/).
* Official extension for Chrome and Chromium-based - [Save to HotPocket](https://chromewebstore.google.com/detail/save-to-hotpocket/mkmoejhhgnadmijpgkkioicjmikkkjbd).
## Progressive Web Application
HotPocket Backend is a Progressive Web Application. It can be installed from the browser and it'll register itself as share target. This is currently supported on Android and Windows 11.