Abdulmuizz HamzatandRotimi Best
b599f1a017
* Update documentation for ClassroomIO: change Fumadocs to Blume, revise MDX format conventions, and clarify sidebar navigation requirements. * docs: update README and scripts for improved preview and error handling * docs: update Discord link in configuration and documentation * docs: add token-auth route and update documentation formatting * Fix formatting in auto-comment-issues.yml * Fix JSON syntax by adding a comma * fix(docs): declare Blume's Astro build deps so Cloudflare build resolves them blume build generates an Astro project under apps/docs/.blume/ that imports astro, @astrojs/mdx, @tailwindcss/vite, tailwindcss, @tailwindcss/typography, @shikijs/twoslash and @scalar/astro. Under pnpm's isolated node_modules these are nested inside blume and not resolvable from the docs app, so a clean --frozen-lockfile build (Cloudflare) fails at 'Cannot find module astro/config'. Declare them directly in @cio/docs, pinned to blume's resolved versions. * refactor(docs): update API reference paths and documentation for clarity * fix: change platofrm url to docs home page * Refactor documentation for self-hosting ClassroomIO - Removed the Supabase Cloud setup guide as it is no longer needed. - Updated the Enterprise SSO documentation to include a reference link for SSO & licensing. - Added new documentation for Content Security Policy (CSP) configuration. - Created a new section for configuring SMTP for email notifications. - Introduced a comprehensive configuration index for self-hosted ClassroomIO, detailing environment variables and their usage. - Added documentation for optional integrations including Google OAuth, OpenAI, and Unsplash. - Documented the generation and usage of required secrets for ClassroomIO. - Created a section for SSO & licensing, detailing the requirements for Enterprise features. - Added object storage configuration documentation, covering both bundled MinIO and external S3-compatible services. - Documented versioning and upgrade processes for ClassroomIO. - Updated the Coolify and Docker self-hosting guides to streamline configuration references and upgrade instructions. - Enhanced the Railway self-hosting guide with links to relevant configuration sections. - Updated token authentication documentation to reference SSO & licensing. * Add comprehensive guides for ClassroomIO features and functionalities - Introduced a new guide for the Student Dashboard, detailing navigation and features available to students. - Added a guide on using Tags for organizing and filtering courses within ClassroomIO. - Created a guide on how to take attendance in courses, including marking attendance and related functionalities. - Developed a Terminology guide to clarify key terms used throughout ClassroomIO. - Implemented a Token Auth guide for signing users into ClassroomIO from external applications using JWT. - Added instructions for using math in the editor with LaTeX support. - Created a guide for customizing the welcome email sent to students upon enrollment in courses. - Added a guide explaining what ClassroomIO is and its key features. - Updated the home documentation to provide a clearer overview of ClassroomIO and its resources. - Enhanced self-hosted configuration documentation with a new guide for deploying ClassroomIO on Dokploy. - Updated links in the self-hosted configuration documentation for better navigation. - Added new images to support the Dokploy deployment guide. - Updated asset packaging script to handle redirects for the new guide structure. - Fixed footer link to point to the correct Getting Started guide. * chore: uprage version * feat(docs): add DigitalOcean deployment guide and flatten guides structure - Add a guide for deploying ClassroomIO on DigitalOcean using Docker Compose and Caddy for automatic HTTPS. - List DigitalOcean as a deployment option in the self-hosting index. - Move guides out of content/docs/guides into content/docs (student-dashboard, tags, terminology, token-auth, what-is-classroomio, audience, cohorts, community, course, enterprise-sso, mcp, organization, quickstart/*). - Rename home.mdx to index.mdx. - Update package-assets script to emit redirects for the old guides paths. --------- Co-authored-by: Rotimi Best <best@classroomio.com>
59 lines
2.0 KiB
Plaintext
59 lines
2.0 KiB
Plaintext
---
|
|
title: Customize the Welcome Email
|
|
description: Write a custom message that students receive automatically when they enroll in a course.
|
|
---
|
|
|
|
Every course can send a personalized welcome email when a student enrolls. Use it to greet students, share what to
|
|
expect, or include a link such as a live session URL.
|
|
|
|
## Write the welcome message
|
|
|
|
<Steps>
|
|
|
|
<Step>
|
|
### Open course settings
|
|
|
|
Go to the course's **Settings** tab and find the **Welcome email** section.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Compose your message
|
|
|
|
Write your message in the rich-text editor. You can format text and add links, for example a welcome note plus your live
|
|
session join link.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Save
|
|
|
|
Save the course settings. Your message is now used for new enrollments.
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
|
|
|
|
## How it sends
|
|
|
|
The welcome email goes out automatically whenever a student enrolls, whether they self-enroll, accept an invite, or are
|
|
added from the audience. Your message appears in the email above the standard "Sign in to the LMS" link.
|
|
|
|
:::info
|
|
Leave the **Welcome email** blank to use ClassroomIO's default welcome message. Formatting is cleaned for safe email
|
|
delivery, so some advanced styling may be simplified.
|
|
:::
|
|
|
|
## Live class courses: automatic session invite
|
|
|
|
For a **Live class** course with a scheduled session, the welcome email also attaches a calendar invite for the next
|
|
session, so students can add it to their calendar the moment they enroll. You do not set this up here; it is pulled from
|
|
the session you scheduled on the lesson. See [Run a Live Class](/guides/live-class).
|
|
|
|
|
|
|
|
## Related guides
|
|
|
|
- [How to Invite Students](/guides/invite-students): add students to a course
|
|
- [How Course Enrollment Works](/guides/course-enrollment): the enrollment flow
|
|
- [Run a Live Class](/guides/live-class): include your session link in the welcome message
|