Added "adding your own containers" documentation
This commit is contained in:
parent
548050c6ff
commit
3de1734a4b
72
content/advanced/add-your-own-containers.md
Normal file
72
content/advanced/add-your-own-containers.md
Normal file
@ -0,0 +1,72 @@
|
||||
---
|
||||
title: "Adding your own containers to YAMS"
|
||||
date: 2023-10-21T21:41:29-03:00
|
||||
draft: false
|
||||
weight: 1
|
||||
summary: Instructions on how to add your own Docker containers to YAMS.
|
||||
---
|
||||
|
||||
Adding your own containers in YAMS is very easy.
|
||||
|
||||
First, go to your install location. For the purposes of this tutorial, I'll use `/opt/yams`.
|
||||
|
||||
```bash
|
||||
cd /opt/yams
|
||||
```
|
||||
|
||||
If you `ls`, you'll see 2 files:
|
||||
- `docker-compose.yaml`: This is YAMS. You shouldn't mess with this file manually.
|
||||
- `docker-compose.custom.yaml`: Here's where you'll add your containers. Any container you add here will be automatically added to the YAMS network and will be able to communicate locally with YAMS.
|
||||
|
||||
To add your containers, you'll have a few environment variables available:
|
||||
|
||||
- `PUID`: Your PUID.
|
||||
- `PGID`: Your PGID.
|
||||
- `MEDIA_DIRECTORY`: Your media directory.
|
||||
- `INSTALL_LOCATION`: Your install location.
|
||||
|
||||
# Adding a container
|
||||
|
||||
As an example, I'll add [Overseerr](https://overseerr.dev/).
|
||||
|
||||
Open `docker-compose.custom.yaml` and add the following information:
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
|
||||
services: # -> Uncomment this line! (remove the "#" in front of it)
|
||||
|
||||
# Add your container here 👇
|
||||
overseerr:
|
||||
image: lscr.io/linuxserver/overseerr:latest
|
||||
container_name: overseerr
|
||||
environment:
|
||||
- PUID=${PUID} # Note how I'm using the env variables here
|
||||
- PGID=${PGID} # Note how I'm using the env variables here
|
||||
volumes:
|
||||
- ${INSTALL_LOCATION}/config/overseer:/config # Note how I'm using the env variables here
|
||||
ports:
|
||||
- 5055:5055
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
To start the container, run:
|
||||
|
||||
```bash
|
||||
yams restart
|
||||
```
|
||||
|
||||
If everything is okay, you should see Overseer installing:
|
||||
|
||||
```bash
|
||||
⠙ overseerr Pulling 5.2s
|
||||
|
||||
|
||||
...
|
||||
```
|
||||
|
||||
And that's it!
|
||||
|
||||
You can find new containers here:
|
||||
- https://fleet.linuxserver.io/ (recommended).
|
||||
- https://hub.docker.com/.
|
@ -2,7 +2,7 @@
|
||||
title: "Backups"
|
||||
date: 2023-01-17T19:38:39-03:00
|
||||
draft: false
|
||||
weight: 3
|
||||
weight: 4
|
||||
summary: Backup your YAMS configuration.
|
||||
---
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: "Lidarr"
|
||||
date: 2023-01-31T11:20:14-03:00
|
||||
draft: false
|
||||
weight: 5
|
||||
weight: 6
|
||||
summary: Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new albums from your favorite artists and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.
|
||||
|
||||
---
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: "Portainer"
|
||||
date: 2023-01-30T15:46:05-03:00
|
||||
draft: false
|
||||
weight: 4
|
||||
weight: 5
|
||||
summary: Deploy, configure, troubleshoot and secure containers in minutes on Kubernetes, Docker, Swarm and Nomad in any data center, cloud, network edge or IIOT device.
|
||||
---
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: "Readarr"
|
||||
date: 2023-01-31T13:52:34-03:00
|
||||
draft: false
|
||||
weight: 6
|
||||
weight: 7
|
||||
summary: Readarr is a ebook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will interface with clients and indexers to grab, sort, and rename them.
|
||||
|
||||
---
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: "Torrenting"
|
||||
date: 2023-01-16T14:48:14-03:00
|
||||
draft: false
|
||||
weight: 2
|
||||
weight: 3
|
||||
summary: Advanced torreting advices.
|
||||
---
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: "VPN"
|
||||
date: 2023-01-15T21:16:29-03:00
|
||||
draft: false
|
||||
weight: 1
|
||||
weight: 2
|
||||
summary: Advanced configuration for the VPN, supported VPN lists and manual configuration.
|
||||
---
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user