Home Portal

NOTE: Home portal is still in early development. Please keep an eye here for updates as this documentation is still very much under construction.

Home portal is a collection of tools, services and applications. Using docker it integrates all the services and applications in a single place and with the help of caddy (reverse proxy) we can access all the services and applications using a single domain.

It is still very early in development so please keep an eye here for all updates.

You can also view the documentation here.

Disclaimer

Home portal is a hobby project, and is only maintained by myself. Therefore it is highly recommended that you do not use this within a production environment. If you decide to use this in a production environment, please do so at your own risk. While I strive to keep this project up to date and secure, I can not guarantee that.

Getting started

To get started with home portal, you will need to have the following installed on your machine:

• Docker
• Docker Compose

Once you have these installed, you can follow the steps below to get home portal installed on your machine:

NOTE: Currently we are busy refactoring the codebase and the documentation. Please keep an eye here for the new updates.

Method 1: Zip File

1. Download the zip file (HomePortal.zip) from the latest release here.
2. Extract the zip file to a location on your machine.
3. Open a terminal and navigate to the extracted folder.

Once you have done this, follow the steps at this link to get it running: Getting Started