From 408246be7fb0ac75c8ca2a3f8981a2b207ca8573 Mon Sep 17 00:00:00 2001 From: Alex Mickelson Date: Fri, 31 Jan 2025 09:20:35 -0700 Subject: [PATCH] updated some docs --- README.md | 15 ++++++++++++++- docker-compose.yml | 1 + 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b459235..3019c3f 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,23 @@ Development command: `dotnet watch --project Management.Web/` ### Enable Image Support -You must set the `ENABLE_FILE_SYNC` environment variable to true. Image paths will be relative to the `/app/image_storage` directory in the container. +You must set the `ENABLE_FILE_SYNC` environment variable to true. Images need to be available in the `/app/public/` directory in the container so that nextjs will serve them as static files. Images can also be set to public URL's on the web. When an image is detected by canvas manager, it will upload the image to the canvas course and keep a lookup table of the original path/url of the image to the canvas course URL. +For Snow College professors, images should be stored in a separate git repo from the `facultyFiles` git repo. Otherwise the `faculty` repository will become cluttered with duplicated large binary images. Set up your volume like this: + +```yml + volumes: + - ~/projects/facultyFiles:/app/public/images/facultyFiles +``` + +You can now embed an image in an assignment by adding something like this line. + +```md +![formulas](/images/facultyFiles/1405/lab-04-simple-math-formulas.png) +``` + # ideas matching questions diff --git a/docker-compose.yml b/docker-compose.yml index 767bc75..e253e4e 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -24,6 +24,7 @@ services: - ~/projects/faculty/1810/2025-spring-alex/online:/app/storage/intro_to_web_online - ~/projects/facultyFiles:/app/public/images/facultyFiles + # https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/ # https://github.com/jonas-merkle/container-cloudflare-tunnel cloudflare-tunnel: