Online Installation

The following guide was tested and verified on 1st January 2024. Operating systems, toolkits, libraries, dependencies, and conventions change constantly. While the processes below will likely be similar in the future, things will inevitably change. Unlike the local set up, nearly all these factors rely on the services, pricing, and policies of third-party providers, which are out of Raston Labs' control.

Prerequisites

The only prerequisite requires is for the ownership and control over a domain name. Many domain name providers exist. If one does not own a domain name already, Cloudflare is a domain registrar that operates at cost without markup fees. If you have experience with another registrar or service, the steps required below are not specific to any registrar.

https://developers.cloudflare.com/registrar/

Front-end

The following front-end guide will follow the steps of setting up the FTIR-SIS front-end using GitHub Pages. At the time of writing, this is free for publicly accessible repositories. First, you will start by creating a GitHub account. With an account, you will traverse to the main page for this repository. Near the top right, under Fork, select Create a new fork. Select Create fork. This creates a personal copy of the repository that you can now freely edit without changing the original.

Next, we will set up our domain to work with GitHub Pages. This setup requires adding multiple A records and one CNAME record. Domain providers differ in what settings they offer, their location in their user interface, and their names. The following shows the records your domain provider needs:

Hostname	Type	TTL	Data
example.com	A	Auto	185.199.108.153
example.com	A	Auto	185.199.109.153
example.com	A	Auto	185.199.110.153
example.com	A	Auto	185.199.111.153
example.com	AAAA	Auto	2606:50c0:8000::153
example.com	AAAA	Auto	2606:50c0:8001::153
example.com	AAAA	Auto	2606:50c0:8002::153
example.com	AAAA	Auto	2606:50c0:8003::153
ftir	CNAME	Auto	github-username.github.io

The A and AAAA record IP addresses may change. To find the most recent please visit the official GitHub documentation: https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site

Next, traverse to your fork on GitHub. Select Actions. Select I understand my workflows, go ahead and enable them.

Next, we need to make some changes to the code to change the references to ftir.rastonlab.org to your domain (ftir.example.com). These changes need to occur in the following places:

package.json

"homepage": "https://ftir.example.com",

src/dictionaries/constants.js (subdomain.example.com is created in the back-end documentation)

export const FIND_PEAKS = "https://subdomain.example.com/find_peaks";
export const BACKGROUND = "https:// subdomain.example.com /background";
export const SAMPLE = "https:// subdomain.example.com /sample";

After committing your changes, revisit Actions. Here we can see the script generating the webpage. Wait until this process is complete. This will be evident by the yellow circle changing to a green checkmark. You may need to refresh the page for this to appear. Select Settings. Select Pages. Under Branch, select gh-pages and save. Under Custom domain, enter your domain (ftir.example.com) and save. GitHub will then perform a DNS verification. This may take a few minutes to a few hours. If it does not return successful within a few minutes, revisit this page again later. Once this returns successfully, your webpage should be live. Please visit https://ftir.example.com to verify.