Documentation

Welcome to the FreeGenes Documentation pages! Here you can quickly jump to a particular page.


Background

Background about FreeGenes before this application

Deployment backup

Deployment backup

Deployment - setting up https

How to configure https to work with your node

Development

Setup, Install, and Deploy via Containers

Export

Export data from the previous https://api.freegenes.org

Models

Details and notes about models

Deployment setup

Deployment setup

Deployment start containers

Start containers to deploy your FreeGenes node

User Stories

User Stories and Interactions to help guide development

Views and URLs

Notes about the design of the interface, including urls and views.

A Nested Page

An example of a nested page

Quiz

How to add interactive quizzes to your site.

Frequenty Asked Questions

Frequently Asked Questions about FreeGenes

Getting Started

Getting started with FreeGenes

Plugins

ldap-auth - Authentication against LDAP directories

pam-auth - Authentication with PAM

saml-auth - Shibboleth Authentication

A Nested Page

An example of a a nested page in a subfolder.

Admin Pages

FreeGenes administrative views

Using the API

The FreeGenes API allows for programmatic access to the server

Error Pages

FreeGenes has custom error pages

Usage

Basic usage of the FreeGenes Interface

Interacting with FreeGenes

A typical user might want to search, or create an order