From e4b7258f7d879863c2c50a326c2046fd5d5882a8 Mon Sep 17 00:00:00 2001 From: Gabe Dunn Date: Mon, 21 Nov 2022 21:36:09 -0700 Subject: [PATCH] Add podman installation instructions to docs (#367) * add podman instructions to installation docs * add mention of podman differences and docs page in readme installation section * make mention of podman instructions more efficient --- README.md | 2 +- docs/Installation.md | 30 +++++++++++++++++++++++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf029fd..e128104 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ Once your YouTube video collection grows, it becomes hard to search and find a s - [Tube Archivist Metrics](https://github.com/tubearchivist/tubearchivist-metrics) to create statistics in Prometheus/OpenMetrics format. ## Installing and updating -There's dedicated user-contributed install steps under [docs/Installation.md](./docs/Installation.md) for Unraid, Truenas and Synology which you can use instead of this section if you happen to be using one of those. Otherwise, continue on. +There's dedicated user-contributed install steps under [docs/Installation.md](./docs/Installation.md) for podman, Unraid, Truenas and Synology which you can use instead of this section if you happen to be using one of those. Otherwise, continue on. For minimal system requirements, the Tube Archivist stack needs around 2GB of available memory for a small testing setup and around 4GB of available memory for a mid to large sized installation. diff --git a/docs/Installation.md b/docs/Installation.md index ee06eed..b49295a 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,12 +1,40 @@ # Detailed Installation Instructions for Various Platforms ## Table of Contents +- [Podman](#podman) - [Unraid](#unraid) - [Truenas Scale](#truenas-scale) - [Synology](#synology) These are beginners guides installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [Readme](https://github.com/tubearchivist/tubearchivist#installing-and-updating). If you see any issues here while using these instructions, please contribute. +## Podman +Podman handles container hostname resolving slightly differently than docker, so you need to make a few changes to the `docker-compose.yml` to get up and running. + +### Step 1: Follow the installation instructions from the [README](https://github.com/tubearchivist/tubearchivist#installing-and-updating), with a few additional changes to the `docker-compose.yml`. + +Edit these additional changes to the `docker-compose.yml`: + - under `tubearchivist`->`image`: + - prefix the container name with `docker.io/` (or the url of your repo of choice). + - under `tubearchivist`->`environment`: + - `ES_URL`: change `archivist-es` to the internal IP of the computer that will be running the containers. + - `REDIS_HOST`: change `archivist-redis` to the internal IP of the computer that will be running the containers (should be the same as above). + - under `archivist-redis`->`image`: + - prefix the container name with `docker.io/` again. + - under `archivist-redis`->`expose`: + - change the whole entry from `expose: [""]` into `ports: [":"]. + - under `archivist-es`->`image`: + - prefix the container name with `docker.io/` again. + - under `archivist-es`->`expose`: + - change the whole entry from `expose: [""]` into `ports: [":"]. + +### Step 2: Create service files (optional) + +Since podman doesn't run as a service, it can't start containers after reboots, at least not without some help. + +If you want to enable this behavior, you can follow [this example](https://techblog.jeppson.org/2020/04/create-podman-services-with-podman-compose/) to have `systemd` start up the containers with `podman-compose` when the computer boots up. + + ## Unraid Tube Archivist, and all if it's dependencies are located in the [community applications](https://forums.unraid.net/topic/38582-plug-in-community-applications/) store. The three containers you will need are as follows: @@ -254,4 +282,4 @@ Once all of the folders have been created, it should have a folder structure wit ### From there, you should be able to start up your containers and you're good to go! -If you're still having trouble, join us on [discord](https://discord.gg/AFwz8nE7BK) and come to the #synology channel. \ No newline at end of file +If you're still having trouble, join us on [discord](https://discord.gg/AFwz8nE7BK) and come to the #synology channel.