Deployment

Supported deployment

If you would like to deploy TaskCollect software but would like some help in the process, contact us! We would be happy to negotiate an online or a potentially an in-person meeting (if we have a representative in your area) to help you get set up and ready to use TaskCollect in your institution.

If you are a larger or official institution, we expect you to have some preliminary ICT infrastructure (including computer networks, servers, firewalls, and intrusion prevention systems) in place. We do not provide specific consulting or support for networking or cybersecurity-related matters.

Independent deployment

You may also choose to deploy TaskCollect independently, without our help. To do so, you should first consult the necessary documentation, in particular the project readme.

To install, you first need to download TaskCollect. Then, unpack the downloaded .tar.gz bundle, and in the unpacked folder, you should see the following files and folders: 

.git/
.gitignore
CONTRIBUTING.md
LICENSE
README.md
STATS.md
cfg/
doc/
makefile
prg/
res/
src/

As TaskCollect is a web server, you will need to generate a TLS private key and TLS certificate. Name them key.pem and cert.pem, respectively, and copy/move them to the res subfolder (of your newly unpacked TaskCollect folder). Your folder should now have the following new files: 

res/cert.pem
res/key.pem

Now that all the required deployment resources are ready, run the following command to deploy to production! 

make deploy

Ensure that you have install Make before running this command. Invoking this command binds the TaskCollect server to TLS port 443 and TaskCollect should now be accessible by accessing the domain name of your server through a web browser.

TaskCollect is currently built as a web server, so you will need to ensure that you have the necessary firewall, rate limiting, and denial of service prevention software configured and running before you officially deploy in production. You will also need to ensure you are able to easily update TaskCollect in case important security patches or bugfixes are released.

Of course, do not hesitate to contact us if you need any help or advice.

Self-hosting

If you want to set up TaskCollect on your own device and use it for personal purposes only, you can self-host the TaskCollect software.

To do so, download TaskCollect. Then, unpack the downloaded .tar.gz bundle, and in the unpacked folder, run the following command: 

make run

Ensure that you have install GNU Make before running this command.

If this command runs successfully, you may proceed to use TaskCollect. Simply open http://localhost:8080/ in your browser and voila!