Setup Guide - SteffenBlake/TaskBud GitHub Wiki

All Platforms

Step 1: Download your matching release zip from the latest release link here: https://github.com/SteffenBlake/TaskBud/releases/latest Windows: You probably want win x64

Step 2: Unzip the archive, doesn't matter where but somewhere you'd like to keep it. C:/TaskBud perhaps?

Step 2: Have an empty, ready to use Database of the supported types (Listed in the AppSettings.json file)

Step 2.a, Postgres: https://www.postgresqltutorial.com/install-postgresql/

step 2.b, MSSQL: https://www.sqlshack.com/how-to-install-sql-server-express-edition/

Step 3: Create a new empty database called TaskBud (any other name is fine as well but TaskBud is what we will use in the connection string for step 5 below)

Step 4: In AppSettings.json, Modify the ConnectionType property to be one of the values supported (listed directly above), matching your DB type

Step 5: In AppSettings.json, Modify the ConnectionString value to point to your database. Guide on connection strings here: https://docs.microsoft.com/en-us/ef/core/miscellaneous/connection-strings

Postgres Example: "ConnectionString": User ID=postgres;Password=YourPasswordHere;Host=localhost;Port=YourPostgresPortHere;Database=TaskBud

Step 6: Modify the Urls value to specify what urls to accept requests from.

Step 7 (Option if you want to expose TaskBud for online, non-local use): Make sure to setup your firewalls and etc to expose the port(s) you are listening on, and configure your router as well for port forwarding, setup a reverse proxy if you are using a domain, and certify for HTTPS

Step 7.a: How to open a firewall port on windows https://www.tomshardware.com/news/how-to-open-firewall-ports-in-windows-10,36451.html

Step 7.b: How to port forward your router to expose HTTP and HTTPS ports: https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/

Step 7.c: Setup a reverse proxy to host on a subdomain with nginx: https://stackoverflow.com/questions/23649444/redirect-subdomain-to-port-nginx-flask

Step 7.d: Use Certbot to certify your domain for secure HTTPS for free (please do this): https://certbot.eff.org/instructions

Windows

Step 8~10: Simply run TaskBud.Website.exe as Administrator and everything should be ready to go. The command line should inform you its now listening on your URLS.

Linux/OSX/Etc

Step 8: Install the latest recommended .Net Core runtime: https://dotnet.microsoft.com/download/dotnet-core

Step 9: Navigate your terminal to the primary folder (The one that has all the .dll files in it, and the AppSettings.json file)

Step 10: run the command dotnet run TaskBud.Website.dll

All Platforms

Step 11: Now open up your browser and navigate the one of the URLs you set to listen on, if all went well your website should boot up!

Step 12: Login as Administrator, default Username/Pass is admin/admin.

Step 13: Please ensure you change Administrator default password! This can be changed via Menu > Profile - Admin > Password

Step 14: Important Create your first Task Group (You need at least one to start making tasks), via Tasks > +Create New

Thats all!