adding readme instructions

This commit is contained in:
2025-07-30 10:07:17 -06:00
parent c5759c0bec
commit 5715b081a9
2 changed files with 33 additions and 5 deletions

View File

@@ -4,12 +4,40 @@
<https://nowucca.com/2020/07/04/working-around-canvas-limitations.html>
## Getting Started and Usage
## Getting Started and Usage (v3)
<!-- draft -->
All class data files are stored in markdown files in a folder. I recommend making this folder a git repo. Here's an example docker compose:
```yml
services:
canvas_manager:
image: alexmickelson/canvas_management:3
user: "1000:1000"
container_name: canvas-manager
ports:
- 3000:3000
env_file:
- .env
environment:
- storageDirectory=/app/storage
- TZ=America/Denver
- NEXT_PUBLIC_ENABLE_FILE_SYNC=true
volumes:
- ./globalSettings.yml:/app/globalSettings.yml
- ~/projects/faculty:/app/storage
- ~/projects/facultyFiles:/app/public/images/facultyFiles
```
The `globalSettings.yml` file specifies which folders in your storage directory you want to display in the UI. This way you can have old classes files stored, but not bring them into the UI unless you need to (like when you are planning a new semester, you might want to see the old semester).
`globalSettings.yml` can start like this, this file will be edited as you add classes to manage.
```yml
courses: []
```
### Enable Image Support
## Enable Image Support
You must set the `NEXT_PUBLIC_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.

View File

@@ -1,8 +1,8 @@
services:
canvas_manager:
image: alexmickelson/canvas_management:2.7
image: alexmickelson/canvas_management:3
user: "1000:1000"
container_name: canvas-manager-2
container_name: canvas-manager
ports:
- 3000:3000
env_file: