From 956a3c75bc81a4051984bedb3f1cae8818cb8343 Mon Sep 17 00:00:00 2001 From: carykees98 Date: Thu, 25 Jul 2024 19:49:24 -0400 Subject: [PATCH] capitalization and update to website creation instructions Signed-off-by: carykees98 --- src/guides/website_creation.md | 35 +++++++++++++------------- src/infrastructure/network/topology.md | 6 ++--- 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/src/guides/website_creation.md b/src/guides/website_creation.md index bc5f664..6347ae1 100644 --- a/src/guides/website_creation.md +++ b/src/guides/website_creation.md @@ -1,29 +1,30 @@ # Creating a website -_updated: Jul 23rd, 2024_ +_updated: Jul 25th, 2024_ -COSI websites are stored in docker containers on [Tiamat](../infrastructure/servers/tiamat.md). +COSI websites are stored in Docker containers on [Tiamat](../infrastructure/servers/tiamat.md). -1. Get permission +1. Get permission to host a site from the current Lab Directors. -2. Create a DNS entry for your website on [zones](https://github.com/COSI-Lab/zones). - - in both db.cosi and db.cslabs files create a new entry +2. Create a DNS entry for your website on [Zones](https://github.com/COSI-Lab/zones). + - Follow the directions in the readme for Zones + - At step 3, add a line to both `db.cosi` and `db.cslabs` using the following format: + ```dns + IN CNAME tiamat ``` - website_name IN CNAME tiamat - ``` - - follow the directions in the readme for zones -3. Place your repo on Tiamat in the `/docker` folder with a `docker-compose.yaml`, a `Dockerfile`, and anything else you need. +3. Clone your repo on Tiamat in the `/docker` directory (at the root of the file system). Your repo must contain a `docker-compose.yaml` as well as anything else that you need for your container to function. -4. Update /docker/caddy/Caddyfile with your website information - ``` - websitename.cslabs.clarkson.edu{ - reverse_proxy websitename:80 +4. Update `/docker/caddy/Caddyfile` with the following information related to your site: + ```caddyfile + .cslabs.clarkson.edu{ + reverse_proxy :80 } - websitename.cosi.clarkson.edu{ - reverse_proxy websitename:80 + + .cosi.clarkson.edu{ + reverse_proxy :80 } - # note: not all entries look like this and more information can be entered ``` + **NOTE:** This is the bare minimum required to make your site available. You can read more about configuring your entry [here](https://caddyserver.com/docs/caddyfile). -5. Restart all the containers using `./run.sh` \ No newline at end of file +5. Restart all the containers by running `./run.sh` in `/docker`. diff --git a/src/infrastructure/network/topology.md b/src/infrastructure/network/topology.md index 2671a5e..0348318 100644 --- a/src/infrastructure/network/topology.md +++ b/src/infrastructure/network/topology.md @@ -1,14 +1,12 @@ # Topology -_updated: Jul 23rd, 2024_ - -Note: Topology graphs have been temporarily removed due to dependency issues with `mdbook-graphviz`. +_updated: Jul 25th, 2024_ # Current Topology ![Current Topology](../../media/images/FinalTopo_SC.png) ## Notes -Servers like mirror and kasper that should ideally be up around the clock were placed in COLO because COLO is backed by a generator. There were a couple of incidents where the power went out on the hill campus that made COSI re-evaluate placement. If you want to know more about why the network changed you can take a look [here](https://carlone-capstone.cosi.clarkson.edu/). +Servers like Mirror and Kasper that should ideally be up around the clock were placed in COLO because it is backed by a generator. There were a couple of incidents where the power went out on the hill campus that made COSI re-evaluate placement. If you want to know more about why the network changed you can take a look [here](https://carlone-capstone.cosi.clarkson.edu/). There is room to add more [VLANs](vlans.md) to the network. Any new VLAN that needs internet connection can use the same port as the private VLAN that connects the two primary fiber switches.