mirror of
https://github.com/tiyn/wiki.git
synced 2025-04-24 16:07:46 +02:00
docker-images: renew documentation
This commit is contained in:
parent
b893c73571
commit
a9ec46ca29
67
wiki/docker-images/linuxserver_-_freshrss.md
Normal file
67
wiki/docker-images/linuxserver_-_freshrss.md
Normal file
@ -0,0 +1,67 @@
|
||||
# linuxserver - jellyfin
|
||||
|
||||
This is a [Docker](/wiki/docker.md) container for a
|
||||
[freshrss](https://freshrss.org/) server.
|
||||
The official container and documentation was made by
|
||||
[linuxserver](https://docs.linuxserver.io/images/docker-freshrss).
|
||||
This docker-rebuild is made up by a `docker-compose.yml` file.
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
|
||||
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
|
||||
## Environment-variables
|
||||
|
||||
Set the following environment-variables in the `environment:` section of the
|
||||
docker-compose file.
|
||||
|
||||
| Name | Usage | Default |
|
||||
| ------ | ---------------------------- | ------- |
|
||||
| `PUID` | Userid to run the container | |
|
||||
| `PGID` | Groupid to run the container | |
|
||||
| `TZ` | specify the timezone | |
|
||||
|
||||
## Volumes
|
||||
|
||||
Set the following volumes in the `volumes:` section of the docker-compose file.
|
||||
|
||||
| Outside mount/volume name | Container mount | Description |
|
||||
| ------------------------- | --------------- | ------------------------------------ |
|
||||
| `config` | `/config` | storage for config files of jellyfin |
|
||||
|
||||
## Ports
|
||||
|
||||
Set the following ports in the `ports:` section.
|
||||
|
||||
| Container Port | Recommended outside port | Protocol | Description |
|
||||
| -------------- | ------------------------ | -------- | ----------- |
|
||||
| `7008` | `80` | TCP | WebUI |
|
||||
|
||||
## rebuild.sh
|
||||
|
||||
```sh
|
||||
#!/bin/sh
|
||||
docker-compose down
|
||||
docker pull lscr.io/linuxserver/freshrss:latest
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## docker-compose.yml
|
||||
|
||||
```yml
|
||||
version: "2.1"
|
||||
services:
|
||||
freshrss:
|
||||
image: lscr.io/linuxserver/freshrss:latest
|
||||
container_name: freshrss
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Etc/UTC
|
||||
volumes:
|
||||
- /path/to/data:/config
|
||||
ports:
|
||||
- 80:80
|
||||
restart: unless-stopped
|
||||
```
|
||||
@ -11,9 +11,11 @@ Create the file `rebuild.sh`.
|
||||
Change the settings according to your needs.
|
||||
Especially change `<VPN.SERVERNAME.COM>` to the URL the VPN is accessible at.
|
||||
If not already done set a port forward or something similar.
|
||||
`PEERS` describes the number of configs to create for
|
||||
`PEERS` is given the number of configs to create for different
|
||||
[clients](/wiki/vpn.md#client-wg).
|
||||
It is also possible to give a list of clients to create.
|
||||
It is also possible to give a list of clients separated by commas
|
||||
(`first,second,third`) to create.
|
||||
The following shows the two options.
|
||||
Then run `./rebuild.sh`
|
||||
|
||||
## Usage
|
||||
|
||||
@ -7,7 +7,8 @@ The official container and documentation was made by
|
||||
|
||||
## Set-up
|
||||
|
||||
Create the file `rebuild.sh` and `nitter.conf` at the same place.
|
||||
Create the file `rebuild.sh`, `docker-compose.yml` and `nitter.conf` at the same
|
||||
place.
|
||||
Change the settings according to your needs and run `./rebuild.sh` afterwards.
|
||||
|
||||
## Volumes
|
||||
@ -30,39 +31,109 @@ Set the following ports with the -p tag.
|
||||
|
||||
```sh
|
||||
#!/bin/sh
|
||||
docker stop nitter
|
||||
docker rm nitter
|
||||
docker pull zedeus/nitter:latest
|
||||
docker run --name nitter \
|
||||
--restart unless-stopped \
|
||||
-v <path to nitter conf folder>/nitter.conf:/src/nitter.conf \
|
||||
-v nitter:/data \
|
||||
-p 8080:8080 \
|
||||
-d zedeus/nitter:latest
|
||||
docker-compose down
|
||||
docker pull awesometechnologies/synapse-admin:latest
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## docker-compose.yml
|
||||
|
||||
```txt
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
nitter:
|
||||
image: zedeus/nitter:latest
|
||||
container_name: nitter
|
||||
ports:
|
||||
- "8080:8080"
|
||||
volumes:
|
||||
- ./nitter.conf:/src/nitter.conf:Z,ro
|
||||
depends_on:
|
||||
- nitter-redis
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: wget -nv --tries=1 --spider http://127.0.0.1:8080/Jack/status/20 || exit 1
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
retries: 2
|
||||
user: "998:998"
|
||||
read_only: true
|
||||
security_opt:
|
||||
- no-new-privileges:true
|
||||
cap_drop:
|
||||
- ALL
|
||||
|
||||
nitter-redis:
|
||||
image: redis:6-alpine
|
||||
container_name: nitter-redis
|
||||
command: redis-server --save 60 1 --loglevel warning
|
||||
volumes:
|
||||
- nitter-redis:/data
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: redis-cli ping
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
retries: 2
|
||||
user: "999:1000"
|
||||
read_only: true
|
||||
security_opt:
|
||||
- no-new-privileges:true
|
||||
cap_drop:
|
||||
- ALL
|
||||
|
||||
volumes:
|
||||
nitter-redis:
|
||||
|
||||
```
|
||||
|
||||
|
||||
## nitter.conf
|
||||
|
||||
```txt
|
||||
[Unit]
|
||||
Description=Nitter (An alternative Twitter frontend)
|
||||
After=syslog.target
|
||||
After=network.target
|
||||
[Server]
|
||||
address = "0.0.0.0"
|
||||
port = 8080
|
||||
https = false # disable to enable cookies when not using https
|
||||
httpMaxConnections = 100
|
||||
staticDir = "./public"
|
||||
title = "nitter"
|
||||
hostname = "nitter.net"
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
[Cache]
|
||||
listMinutes = 240 # how long to cache list info (not the tweets, so keep it high)
|
||||
rssMinutes = 10 # how long to cache rss queries
|
||||
redisHost = "nitter-redis"
|
||||
redisPort = 6379
|
||||
redisPassword = ""
|
||||
redisConnections = 20 # connection pool size
|
||||
redisMaxConnections = 30
|
||||
# max, new connections are opened when none are available, but if the pool size
|
||||
# goes above this, they're closed when released. don't worry about this unless
|
||||
# you receive tons of requests per second
|
||||
|
||||
# set user and group
|
||||
User=nitter
|
||||
Group=nitter
|
||||
[Config]
|
||||
hmacKey = "secretkey" # random key for cryptographic signing of video urls
|
||||
base64Media = false # use base64 encoding for proxied media urls
|
||||
enableRSS = true # set this to false to disable RSS feeds
|
||||
enableDebug = false # enable request logs and debug endpoints
|
||||
proxy = "" # http/https url, SOCKS proxies are not supported
|
||||
proxyAuth = ""
|
||||
tokenCount = 10
|
||||
# minimum amount of usable tokens. tokens are used to authorize API requests,
|
||||
# but they expire after ~1 hour, and have a limit of 187 requests.
|
||||
# the limit gets reset every 15 minutes, and the pool is filled up so there's
|
||||
# always at least $tokenCount usable tokens. again, only increase this if
|
||||
# you receive major bursts all the time
|
||||
|
||||
# configure
|
||||
WorkingDirectory=/home/nitter/nitter
|
||||
ExecStart=/home/nitter/nitter/nitter
|
||||
|
||||
Restart=always
|
||||
RestartSec=15
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
# Change default preferences here, see src/prefs_impl.nim for a complete list
|
||||
[Preferences]
|
||||
theme = "Nitter"
|
||||
replaceTwitter = "nitter.net"
|
||||
replaceYouTube = "piped.video"
|
||||
replaceReddit = "teddit.net"
|
||||
proxyVideos = true
|
||||
hlsPlayback = false
|
||||
infiniteScroll = false
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user