https://github.com/cromefire/jf-server-announcer
A small application that may be used to advertise a Jellyfin Server under a different address / name or inside another local network. (Mirror, only issues, not pull requests via GitHub, use GitLab merge requests instead)
https://github.com/cromefire/jf-server-announcer
gitlab-mirror golang jellyfin
Last synced: 8 months ago
JSON representation
A small application that may be used to advertise a Jellyfin Server under a different address / name or inside another local network. (Mirror, only issues, not pull requests via GitHub, use GitLab merge requests instead)
- Host: GitHub
- URL: https://github.com/cromefire/jf-server-announcer
- Owner: cromefire
- License: gpl-3.0
- Created: 2020-12-13T16:27:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-13T17:27:08.000Z (over 5 years ago)
- Last Synced: 2025-07-08T12:45:04.284Z (11 months ago)
- Topics: gitlab-mirror, golang, jellyfin
- Language: Go
- Homepage: https://gitlab.com/cromefire_/jf-server-announcer
- Size: 24.4 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .gitlab/CODEOWNERS
Awesome Lists containing this project
README
# Jellyfin Server Announcer
[](https://gitlab.com/cromefire_/jf-server-announcer)
[](https://gitlab.com/cromefire_/jf-server-announcer/-/pipelines)
This is a small application that may be used to advertise a Jellyfin Server under a different address / name or inside another local network.
## Use cases
This is useful in 2 cases primarily:
- Your server ist behind a reverse proxy and not (securely) reachable for it local ip address that it advertises
- Your want to advertise a server inside you network that is not inside you network (e.g. a friend's server)
## Usage
The app needs 3 parameters:
- `--id`: The Jellyfin server ID (see below)
- `--address`: The address the clients should use to communicate with Jellyfin (include the protocol and (if applicable) the base url, e.g. `https://jellyfin.example.com` or `http://1.2.3.4:8006/jellyfin`)
- `--name`: The Jellyfin server name as it should be shown to the clients, useful, if you have multiple servers being announced in the local network
You can get the current parameters by navigating to your Jellyfin instance, logging in and pasting the following into your browser console, you will sometimes want to change your address though.
_(only do this, if you can understand what this code does, your browser will also warn you about not pasting untrusted code)_
```javascript
JSON.parse(localStorage.getItem("jellyfin_credentials")).Servers.forEach((e, i) => console.info(`Server ${i + 1}: --id="${e.Id}" --name="${e.Name}" --address="${e.ManualAddress}"`));
```
## Installation
_It's only tested on linux so far and binaries are only available for amd64, it should word on other platforms though._
You can fetch the binary from the [packages](https://gitlab.com/cromefire_/jf-server-announcer/-/packages) and make it executable.
For the sake of security it's probably best to add a user for it, so it's not running as root:
```shell
sudo adduser --system --disabled-login --group --home /var/lib/jf-server-announcer jf-server-announcer
```
You also have to open port `7359/udp` if you have a fire wall, because this is the port it uses to communicate
If you use systemd, here's a sample unit file (with a bit of hardening applied):
jf-server-announcer.service
```unit file (systemd)
[Unit]
Description=Jellyfin Server Announcer
After=network-online.target
[Service]
Type=simple
ExecStart=/path/to/jf-server-announcer --id "..." --address "https://..." --name "..."
Restart=on-failure
RestartSec=60s
# Hardening
User=jf-server-announcer
Group=jf-server-announcer
PrivateTmp=true
ProtectSystem=strict
NoNewPrivileges=true
RestrictNamespaces=uts ipc pid user cgroup
ProtectKernelTunables=yes
ProtectKernelModules=yes
ProtectControlGroups=yes
PrivateDevices=yes
RestrictSUIDSGID=true
[Install]
WantedBy=multi-user.service
```
## Building
This is a standard go modules project, so you just have to have [go](https://golang.org) installed and run `go build`.