From a8705b049f572df71afd0de1f26454c14ccad662 Mon Sep 17 00:00:00 2001 From: CheeseLad Date: Wed, 19 Jun 2024 05:44:12 +0100 Subject: [PATCH] started work on vps service list and pages --- docs/vps/info.md | 17 ++++++ docs/vps/services/cheeselad-website.md | 29 ++++++++++ docs/vps/services/clubsandsocs-api.md | 71 +++++++++++++++++++++++++ docs/vps/services/dcufotosoc-website.md | 25 +++++++++ docs/vps/services/dcumps-website.md | 29 ++++++++++ 5 files changed, 171 insertions(+) create mode 100644 docs/vps/info.md create mode 100644 docs/vps/services/cheeselad-website.md create mode 100644 docs/vps/services/clubsandsocs-api.md create mode 100644 docs/vps/services/dcufotosoc-website.md create mode 100644 docs/vps/services/dcumps-website.md diff --git a/docs/vps/info.md b/docs/vps/info.md new file mode 100644 index 0000000..01aa825 --- /dev/null +++ b/docs/vps/info.md @@ -0,0 +1,17 @@ +# VPS Information + +## Specs + +- 1 vCPU +- 2GB RAM +- 20GB SSD +- 100Mbps Network +- Provider: [OVH](https://www.ovh.ie/) + +## Services + +- [CheeseLad Website](/vps/services/cheeselad-website) +- [DCU Fotosoc Website](/vps/services/dcufotosoc-website) +- [DCUMPS Website](/vps/services/dcumps-website) +- [Portainer](/vps/services/portainer) +- [Traefik](/vps/services/traefik) \ No newline at end of file diff --git a/docs/vps/services/cheeselad-website.md b/docs/vps/services/cheeselad-website.md new file mode 100644 index 0000000..e8362cc --- /dev/null +++ b/docs/vps/services/cheeselad-website.md @@ -0,0 +1,29 @@ +# CheeseLad Website + +## Docker Compose File + +```yaml +services: + cheeselad-website: + image: nginx:latest + container_name: cheeselad-website + hostname: cheeselad-website + restart: unless-stopped + volumes: + - ./html:/usr/share/nginx/html + labels: + - "traefik.enable=true" + - "traefik.http.routers.cheeselad-website.entrypoints=https" + - "traefik.http.routers.cheeselad-website.rule=Host(`www.cheeselad.xyz`)" + - "traefik.http.routers.cheeselad-website-base-url.entrypoints=https" + - "traefik.http.routers.cheeselad-website-base-url.rule=Host(`cheeselad.xyz`)" + +networks: + default: + name: traefik_net + external: true +``` + +## Notes + +- Access CheeseLad's website here: [`https://cheeselad.xyz`](https://cheeselad.xyz) \ No newline at end of file diff --git a/docs/vps/services/clubsandsocs-api.md b/docs/vps/services/clubsandsocs-api.md new file mode 100644 index 0000000..8e3ec51 --- /dev/null +++ b/docs/vps/services/clubsandsocs-api.md @@ -0,0 +1,71 @@ +# Clubs & Socs API + +## Description + +Allows you to get information about societies and clubs from university websites using the [Assure Memberships Platform](https://assurememberships.com) for use in other applications. + +## Supported Sites + +- [DCU Clubs & Socs](https://dcuclubsandsocs.ie) + - Site Code: `dcuclubsandsocs.ie` +- [MU Clubs & Societies](https://mulife.ie/) + - Site Code: `mulife.ie` +- [SETU Waterford Sports Clubs & Societies](https://waterford.sportsclubsandsocieties.setu.ie/) + - Site Code: `waterford.sportsclubsandsocieties.setu.ie` +- [UL Clubs & Societies](https://ulwolves.ie/) + - Site Code: `ulwolves.ie` +- [ATU Sligo Clubs & Socs](https://sligo.atusulife.ie/) + - Site Code: `sligo.atusulife.ie` +- [ATU Donegal Clubs & Socs](https://donegal.atusulife.ie/) + - Site Code: `donegal.atusulife.ie` + +## Supported Types + +- `society` +- `club` + +## Installation + +1. Clone the repository +2. Run `pip install -r requirements.txt` to install the required packages +3. Run `flask run` to start the API server + +## Usage + +The API has the following endpoints: + +- `////events` - Get all upcoming events for a society/club +- `////committee` - Get the committee information for a society/club +- `////gallery` - Get the gallery photos for a society/club +- `////activities` - Get all weekly activities for a society/club + +## API Usage Examples + +- `/dcuclubsandsocs.ie/society/redbrick/events` - Get all upcoming events for Redbrick Society in DCU +- `/mulife.ie/society/esn/committee` - Get the committee information for the Erasmus Student Network Society in Maynooth University +- `/dcuclubsandsocs.ie/society/media-production/gallery` - Get the gallery photos for the Media Production Society in DCU +- `/mulife.ie/club/table-tennis/activities` - Get all weekly activities for the Table Tennis Club in Maynooth University + +## Docker Compose File + +```yaml +services: + clubsandsocs-api: + image: ghcr.io/cheeselad/clubsandsocs-api:latest + container_name: clubsandsocs-api + hostname: clubsandsocs-api + restart: unless-stopped + labels: + - "traefik.enable=true" + - "traefik.http.routers.clubsandsocs-api.entrypoints=https" + - "traefik.http.routers.clubsandsocs-api.rule=Host(`clubsandsocs.jakefarrell.ie`)" + +networks: + default: + external: + name: traefik_net +``` + +## Notes + +- Access the Clubs & Socs API here: [`https://clubsandsocs.jakefarrell.ie`](https://clubsandsocs.jakefarrell.ie) \ No newline at end of file diff --git a/docs/vps/services/dcufotosoc-website.md b/docs/vps/services/dcufotosoc-website.md new file mode 100644 index 0000000..fcfbb0c --- /dev/null +++ b/docs/vps/services/dcufotosoc-website.md @@ -0,0 +1,25 @@ +# DCU Fotosoc Website + +## Docker Compose File + +```yaml +services: + dcufotosoc-website: + image: ghcr.io/cheeselad/fotosoc:latest + container_name: dcufotosoc-website + hostname: dcufotosoc-website + restart: unless-stopped + labels: + - "traefik.enable=true" + - "traefik.http.routers.dcufotosoc-website.entrypoints=https" + - "traefik.http.routers.dcufotosoc-website.rule=Host(`dcufotosoc.jakefarrell.ie`)" + +networks: + default: + name: traefik_net + external: true +``` + +## Notes + +- Access CheeseLad's website here: [`https://dcufotosoc.jakefarrell.ie`](https://dcufotosoc.jakefarrell.ie) \ No newline at end of file diff --git a/docs/vps/services/dcumps-website.md b/docs/vps/services/dcumps-website.md new file mode 100644 index 0000000..bd637de --- /dev/null +++ b/docs/vps/services/dcumps-website.md @@ -0,0 +1,29 @@ +# DCUMPS Website + +## Docker Compose File + +```yaml +services: + dcumps-website: + image: ghcr.io/dcumps/dcumps-website-django:latest + container_name: dcumps-website + hostname: dcumps-website + restart: unless-stopped + labels: + - "traefik.enable=true" + - "traefik.http.routers.dcumps-website.entrypoints=https" + - "traefik.http.routers.dcumps-website.rule=Host(`www.dcumps.ie`)" + - "traefik.http.routers.dcumps-website.tls.certresolver=dcumps" + - "traefik.http.routers.dcumps-website-base-url.entrypoints=https" + - "traefik.http.routers.dcumps-website-base-url.rule=Host(`dcumps.ie`)" + - "traefik.http.routers.dcumps-website-base-url.tls.certresolver=dcumps" + +networks: + default: + external: + name: traefik_net +``` + +## Notes + +- Access CheeseLad's website here: [`https://dcumps.ie`](https://dcumps.ie) \ No newline at end of file