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>
73 lines
2.1 KiB
Plaintext
73 lines
2.1 KiB
Plaintext
---
|
|
title: Inviting a Team Member
|
|
description: Add admins and tutors to your organization by email invite or a reusable invite link.
|
|
---
|
|
|
|
Team members are people who help you run your organization — **Admins** have full access, **Tutors** can manage the courses they are assigned to. Both are different from students, who use the LMS and cannot access the admin dashboard.
|
|
|
|
:::warning[Paid plan required]
|
|
Email invites and link invites for team members require a paid plan.
|
|
:::
|
|
|
|
To invite a team member, go to **Settings → Organization**, then click **Manage Team**.
|
|
|
|
## Invite by email
|
|
|
|
<Steps>
|
|
<Step>
|
|
### Enter email addresses
|
|
|
|
Type one or more email addresses into the invite field. Separate multiple addresses with commas.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Select a role
|
|
|
|
Choose **Admin** or **Tutor** from the role dropdown.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Send the invite
|
|
|
|
Click **Send invite**. Each recipient receives an email with a link to join your organization at the selected role.
|
|
</Step>
|
|
</Steps>
|
|
|
|
Invited members appear in the team list with an **Invite Sent** badge until they accept. You can remove a pending or accepted member at any time using the **Remove** button next to their name.
|
|
|
|
## Invite by link
|
|
|
|
A link invite lets you share one URL that anyone can use to join your org at a specific role — useful for onboarding multiple people at once without entering individual email addresses.
|
|
|
|
<Steps>
|
|
<Step>
|
|
### Select a role for the link
|
|
|
|
Choose **Admin** or **Tutor**.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Generate the link
|
|
|
|
Click **Generate**. A shareable URL appears.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Copy and share
|
|
|
|
Click **Copy** and share the link however you prefer. Anyone who opens it and signs in (or signs up) joins your org at the selected role.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Disable the link when done
|
|
|
|
Toggle the link off to stop accepting new members through it. You can re-enable it later or generate a new link.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Related guides
|
|
|
|
- [Roles and Permissions](/guides/roles-and-permissions) — what admins and tutors can do
|
|
- [How to Invite Students](/guides/invite-students) — invite students to a specific course (separate from team invites)
|
|
- [Organization](/organization) — org settings overview
|