canvas-lms-docker

KO | EN

gitlite — search

#javascript #python #typescript #android #rust #deep-learning #java #windows #awesome #awesome-list #vue #security #ios #open-source

canvas-lms-docker

(★ 18)

Dockerized Canvas LMS Self-hosted Configuration

canvas-lms-docker 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Canvas LMS Docker

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ahamana/canvas-lms-docker/main/LICENSE)

This repository provides Docker configurations for running [Canvas LMS](https://github.com/instructure/canvas-lms) in a containerized environment.

## Features

- Docker configurations for both Debian and Alpine Linux environments
- PostgreSQL database integration
- Valkey cache support
- Mailpit for email testing

## Requirements

- Docker and Docker Compose
- [Task](https://taskfile.dev/)

## Quick Start

### Debian-based

| Operation | Command                          |
| --------- | -------------------------------- |
| Set up    | `task setup DISTRIBUTION=debian` |
| Start     | `task start DISTRIBUTION=debian` |
| Stop      | `task stop DISTRIBUTION=debian`  |

### Alpine-based

| Operation | Command                          |
| --------- | -------------------------------- |
| Set up    | `task setup DISTRIBUTION=alpine` |
| Start     | `task start DISTRIBUTION=alpine` |
| Stop      | `task stop DISTRIBUTION=alpine`  |

## Services

| Service    | Role                 | Endpoint                |
| ---------- | -------------------- | ----------------------- |
| Canvas LMS | Canvas LMS interface | `http://localhost`      |
| PostgreSQL | Database             | `localhost:5432`        |
| Valkey     | Cache                | -                       |
| Mailpit    | Email testing        | `http://localhost:8025` |

## Configuration

The environment is configured through the `.env` file which contains all the necessary environment variables.

### Main Settings

| Variable | Default | Description |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `EMAIL_DOMAIN` | `example.com` | Specifies the domain part of email addresses. |
| `EMAIL_HOST_USER` | `user` | Authentication username for the SMTP server. |
| `EMAIL_HOST_PASSWORD` | `password` | Authentication password for the SMTP server. |
| `EMAIL_SENDER_ADDRESS` | `canvas@${EMAIL_DOMAIN}` | Email address used as the sender for outgoing emails. |
| `EMAIL_SENDER_NAME` | `Instructure Canvas` | Display name used for outgoing emails. |
| `CANVAS_LMS_DOMAIN` | `localhost` | Specifies the domain name for the Canvas LMS application. Can be kept as "localhost" for local environments. |
| `CANVAS_LMS_ADMIN_EMAIL` | `admin@${EMAIL_DOMAIN}` | Email address for the administrator account. Automatically generated from the email domain. |
| `CANVAS_LMS_ADMIN_PASSWORD` | `password` | Password for the administrator account. |
| `CANVAS_LMS_ACCOUNT_NAME` | `Canvas Admin` | Name for the main Canvas LMS account. |
| `CANVAS_LMS_STATS_COLLECTION` | `opt_out` | Controls usage statistics collection. Options: `opt_in`, `opt_out`, or `anonymized`. |
| `CANVAS_LMS_STORAGE_TYPE` | `local` | Specifies the storage type for Canvas LMS file storage. Options: `local` or `s3`. Set to `local` to store files on the local file system. Set to `s3` to store files in Amazon S3 or Amazon S3 compatible object storage. |
| `CANVAS_LMS_STORAGE_PATH_PREFIX` | (empty) | Specifies the storage path prefix for Canvas LMS files. When empty, the Canvas LMS default path is used. Set this variable if you want to change the default path. |
| `CANVAS_LMS_ENCRYPTION_KEY` | `12345678901234567890` | Encryption key used by Canvas LMS for securing sensitive data. This should be a unique, long string (at least 20 characters or more). **Important**: Change this to a secure, random value in production environments. |
| `CANVAS_LMS_JWT_ENCRYPTION_KEYS` | <code>1234567890123456&ZeroWidthSpace;789abcdefghijklm&ZeroWidthSpace;nopqrstuvwxyz123&ZeroWidthSpace;4567890123456789</code> | Secret key used for signing and verifying JWTs (JSON Web Tokens). Each key should be a secure, random 64-character secret. **Important**: Change these to secure, random values in production environments. |
| `POSTGRES_USER` | `canvas` | PostgreSQL database username. |
| `POSTGRES_PASSWORD` | `canvas` | PostgreSQL database password. Recommended to change to a strong password in production environments. |
| `POSTGRES_DB` | `canvas` | PostgreSQL database name. |
| `TZ` | `UTC` | Specifies the timezone. |

### Amazon S3 Settings

| Variable                | Description                                                           | Required                                                                  |
| ----------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `AWS_S3_BUCKET`         | Amazon S3 bucket name for storing Canvas LMS files.                   | When `CANVAS_LMS_STORAGE_TYPE` is set to `s3`.                            |
| `AWS_ACCESS_KEY_ID`     | AWS access key ID for authentication.                                 | When `CANVAS_LMS_STORAGE_TYPE` is set to `s3`.                            |
| `AWS_SECRET_ACCESS_KEY` | AWS secret access key for authentication.                             | When `CANVAS_LMS_STORAGE_TYPE` is set to `s3`.                            |
| `AWS_REGION`            | AWS region where the Amazon S3 bucket is located.                     | When `CANVAS_LMS_STORAGE_TYPE` is set to `s3`.                            |
| `AWS_ENDPOINT`          | Custom endpoint for Amazon S3 compatible object storage (e.g. MinIO). | Only when using Amazon S3 compatible object storage instead of Amazon S3. |

canvas-lms-docker

canvas-lms-docker 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

canvas-lms-docker

canvas-lms-docker 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README