Skip to content

Installation

Mihail Morosan edited this page Jun 29, 2023 · 1 revision

Installation

The recommended way of setting up HomeTG is via Docker Compose.

Docker

Easiest is via Portainer (just create a new stack and point it to this repo, then change volumes as needed).

Alternatively, you can also clone the repo (or the release you want) and run docker-compose up.

Finally, there's a Dockercompose in both the API project and the React fronted project for you if you want to go full manual.

Other

You can run the API directly by compiling the solution. It should run on any OS supported by .NET Core without issues.

Similarly, the React frontend requires Node.js.

Sqlite storage considerations

If using Sqlite, HomeTG stores all its user data in /usr/share/hometg, so make sure to map that volume in Docker so it does not get lost, or keep that in mind if running bare-metal on Linux.

On Windows, data is stored in ProgramData\hometg.

Clone this wiki locally