## 📝 Table of Contents
1. [Introduction](#introduction)
2. [Installation](#installation)
3. [Updating](#updating)
4. [Demo](#demo)
5. [Documentation](#docs)
6. [Products, Services and Support](#hdinnovations)
7. [Contributing](#contributing)
8. [Translations](#translations)
9. [License](#license)
## 🧐 Introduction
UNIT3D (pronounced "united") is a modern FOSS Private Torrent Tracker software built with Laravel, Livewire and AlpineJS. It offers a feature-rich platform with excellent performance, security and scalability to create and manage a private tracker. It is MySQL Strict Mode Compliant and PHP 8.4 Ready. It uses an MVC Architecture to ensure clarity between logic and presentation.
## 🖥️ Installation
### Production
For production deployments, we offer a streamlined Rust-based automated installer for Ubuntu 22.04/24.04 LTS. This tool handles the complete setup process, start to finish, providing a production-ready UNIT3D instance. Upon purchase you will receive a zip file containing a guide and binary installer file. Polar will provide you with a license key for the installer.
Available for purchase here: https://buy.polar.sh/polar_cl_8sOwJuTWkAue5HA80Ns5B4INEuZ2Ia9GvgRxu1m9gXZ
Alternatively, manual installation instructions for a local development environment are available below. There is no official FOSS production installer. You are free to use ones out there but we will not provide support.
### Development
Guides for MacOS and Arch Linux can be found here. Windows guide is being worked on.
https://hdinnovations.github.io/UNIT3D
## 🖥️ Updating
To update your installation to the latest version, run the following command. This will pull the latest changes from the repository and update your instance:
`sudo php artisan git:update`
## 🖥️ Demo
Domain: https://unit3d.dev
Username: `UNIT3D`
Password: `5KNC9THFbFyyG0XEdN2v0y4U`
## 📚 Documentation
https://hdinnovations.github.io/UNIT3D
## 🛠️ Products, Services and Support
HDInnovations offers a variety of services to help you with your UNIT3D instance. We offer services such as installation, updating, server tuning, dependency tuning, themes, porting from a different codebase and more. We have a Discord server for support and general discussion. This is a private server, and you will need to be invited to join. There is a small fee to join the server to help support the development of UNIT3D. UNIT3D itself is FOSS!
https://hdinnovations.github.io/HDInnovations
## 🤝 Contributing
Please read [CONTRIBUTING.md](https://github.com/HDInnovations/UNIT3D/blob/master/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests to us. A massive thank you to all of our contributors.
## 🌎 Translations
We use Weblate for translations. You can easily contribute to translations at https://hosted.weblate.org/engage/unit3d/. Use the following graphic to see if your native language could use some work.
## 📜 License
This project is licensed under the AGPL v3.0 License. See the [LICENSE](https://github.com/HDInnovations/UNIT3D/blob/master/LICENSE) file for details.