JF-secure

A tool stack to automatically reverse proxy Jellyfin
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

There are many great reverse-proxy tools available on GitHub, however, I didn't find one that really suit my needs and was user friendly for beginner users, so I decided to take open source software like Caddy Web-server and WinSSW to create a tool stack that will reverse-proxy Jellyfin for you. I wanted it to be automated and easy to use, even for novice users.

Built With

• Visual Basic .NET Framework (4.8)
• WinSSW
• Caddy Webserver

Getting Started

To get a local copy up and running follow these simple steps. Clone the repo and enter the JF-Secure RW directory from there open up the Visual Studio (2022) Solution

Prerequisites

• A Custom Domain (Ideally using Dynamic DNS)
• Port 80 & 443 forwarded to the Server
• Exemption in the firewall for port 80 & 443
• Remote access allowed in Jellyfin

Installation

1. Download the latest release
2. Run the installer
3. Click the shortcut on the desktop
4. The Program will ask some questions i.e. domain and address of the Jellyfin Server.
5. The Program will perform some background Tasks and then You are all set to go. That may require Admin Privelieges, Click yes to allow those.
6. The service automatically starts in the background upon system start.

Uninstalling

1. Open up JF-Secure
2. When Prompted enter 2 (The option for uninstalling Service)
3. Close the Program
4. Run the Uninstaller

Manually Creating a Backup

As of now the BackUp Create Function is flawed so you need to create a manual backup

1. Enter the Install Directory of JF-Secure
2. Find the Caddyfile
3. Copy it to your desired destination
4. Rename it to backup.jfsbk You can now use this to restore your Installation

Usage

1. To reverse-proxy Jellyfin
2. To enable remote-access
3. If you change the port and address when prompted for the address of the Jellyfin Server, you can also reverse proxy other services, however additional configuration will be required and I will not be able to help you in Troubleshooting

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Dayyan Abdullah - contact@dayyanabdullah.tech Please don't contact me for useless stuff like Technical Support and issues, for those open a Github issue.

Project Link: https://github.com/dab2020/JF-secure