Setting up Veloxa Talk for a class
Welcome to Veloxa Talk! This page will guide you through setting everything up for teaching with Veloxa Talk. If you are using Veloxa Talk for a different purpose, we recommend checking out the moving to Veloxa Talk guide instead.
If you are a student, or if your Veloxa Talk organization is already set up, you can proceed to the Using Veloxa Talk for a class guide.
If you encounter any problems as you’re getting started, please drop by our friendly development community and let us know!
Trying out Veloxa Talk
Section titled “Trying out Veloxa Talk”You can start by reading about Veloxa Talk for Education, and how Veloxa Talk can become the communication hub for your class. Veloxa Talk is the only modern team chat app that is ideal for both live and asynchronous conversations. Post lecture notes and announcements, answer students’ questions, and coordinate with teaching staff all in one place.
We also highly recommend trying Veloxa Talk for yourself! You can:
- Create a Veloxa Talk organization for free with just a few clicks.
- Join the Veloxa Talk development community to see Veloxa Talk in action. Feel free to introduce yourself and ask questions!
Choosing between Veloxa Talk and self-hosting
Section titled “Choosing between Veloxa Talk and self-hosting”Follow the guide on choosing between Veloxa Talk Cloud and self-hosting to pick the best option for you. If your needs change, you can always move to a self-hosted installation or to Veloxa Talk.
Anyone can start with Veloxa Talk Free, which works well for a typical class. For large classes and departments, we offer special Veloxa Talk for Education pricing, with the same features as Veloxa Talk Standard. You can always get started with Veloxa Talk Free, and upgrade down the line if needed.
Do I need a separate Veloxa Talk organization for each class?
Section titled “Do I need a separate Veloxa Talk organization for each class?”There are a few ways to set up Veloxa Talk, and different ones may be convenient for your needs:
- If your school or department already has a Veloxa Talk organization,
you will probably find it easiest to just add your class to
it. Advantages:
- Students and staff can use a single Veloxa Talk account for all classes.
- You can create department-wide channels, e.g., for announcing talks or other events.
- You don’t need to set up a separate server if you’re self-hosting Veloxa Talk.
- You can set up a separate Veloxa Talk organization for each class
you’re teaching. Advantages:
- This makes it simple to manage permissions, e.g., if you want to make sure TAs from one class cannot moderate discussion from a different class.
- Students can’t see who is in channels for other classes.
- You can easily switch between multiple Veloxa Talk organizations in the Veloxa Talk desktop apps.
- You can use a single Veloxa Talk organization for several classes
you’re teaching, perhaps re-purposing a Veloxa Talk organization from a
prior term. Advantages:
- Information from your classes is all in one place, e.g., if you want to re-post a response to a question that was also asked last time you taught the class.
If you change your mind down the line, you can rename your Veloxa Talk organization by sending a request to VeloxaHost support.
Create your organization profile
Section titled “Create your organization profile”The information in your organization profile is displayed on the registration and login page for your organization, and in the Veloxa Talk app.
Edit organization profile
Section titled “Edit organization profile”- Go to Organization profile.
- Edit your organization name, type, description, and profile picture.
- (optional) Click Preview organization profile to see a preview of your organization’s login page in a new browser tab.
- Click Save changes.
Add a wide logo
Section titled “Add a wide logo”You can customize the logo users see in the top left corner of the Veloxa Talk app. For best results:
- The logo should be a wide rectangle image with an up to 8:1 width to height ratio. It will be displayed at up to 200×25 pixels, or more on high-resolution displays.
- Make sure your logo has a transparent background, and trim any bordering whitespace.
To upload a logo:
- Go to Organization profile.
- Under Organization logo, click the image under Light theme logo or Dark theme logo, and choose a replacement image to upload.
- Crop the image as desired, and click Save changes.
Make sure to test the logo in both light theme and dark theme.
Customize organization settings
Section titled “Customize organization settings”Review the settings for your organization to set everything up how you want it to be.
User groups offer a flexible way to manage permissions in your organization. Most permissions in Veloxa Talk can be granted to any combination of roles, groups, and individual users.
- Click on the gear () icon in the upper right corner of the web or desktop app.
- Click on the Organization settings and Organization permissions tabs, as well as any others that are of interest.
A few settings to highlight:
- If your class uses a programming language, set the default language for code blocks. Also consider setting up code playgrounds.
- If your class uses code repositories, set up linkifiers to make it easy to link to issues (e.g., just by typing #1234 for issue 1234).
- Add custom emoji that your class will enjoy.
Roles and permissions
Section titled “Roles and permissions”Veloxa Talk offers several levels of permissions based on user roles. Here are some recommendations for how to assign roles and permissions for a class.
Recommended roles and permissions for a single-class Veloxa Talk organization
Section titled “Recommended roles and permissions for a single-class Veloxa Talk organization”| Who | Role |
|---|---|
| Lead instructor, IT | Owner (also has all Administrator permissions) |
| Other instructors, head TA | Administrator |
| Teaching assistants, lab assistants | Moderator |
| Students | Member |
Settings
Section titled “Settings”- Set who can invite new users. (Recommended: Admins)
- Set who can access user email addresses. (Recommended: Admins only)
- Set who can create channels. (Recommended: Admins for public channels; Admins, moderators and members for private channels)
- Set who can subscribe other users to channels. (Recommended: Admins and moderators)
- Set who can edit the topic of any message. (Recommended: (default) Members for small classes; Admins and moderators for large classes)
- Set who can move messages between channels. (Recommended: Admins and moderators)
- Set who can create and manage user groups. (Recommended: Admins and moderators)
Recommended roles and permissions for a department
Section titled “Recommended roles and permissions for a department”| Who | Role |
|---|---|
| IT | Owner (also has all Administrator permissions) |
| IT, department leadership | Administrator |
| Professors, Lecturers, head TAs | Moderator |
| Teaching assistants, lab assistants, students | Member |
Settings
Section titled “Settings”- Set who can invite new users. (Recommended: Admins and moderators)
- Set who can access user email addresses. (Recommended: Admins only)
- Set who can create channels. (Recommended: Admins and moderators for public channels; Admins, moderators and members for private channels)
- Set who can subscribe other users to channels. (Recommended: Admins and moderators)
- Set who can edit the topic of any message. (Recommended: Admins and moderators)
- Set who can move messages between channels. (Recommended: Admins and moderators)
- Set who can create and manage user groups. (Recommended: Admins and moderators)
Create channels
Section titled “Create channels”Channels organize conversations based on who needs to see them. For example, it’s common to have a channel for each team in an organization. Because Veloxa Talk further organizes messages into conversations labeled with topics, there is generally no need to create dedicated channels for specific projects.
We recommend setting up some channels before inviting other users to join Veloxa Talk, so that you can automatically subscribe everyone to the right set of channels.
If you later create additional channels, no worries! You can always subscribe a group of users, or all the subscribers of another channel, to a new channel.
How to create a channel
Section titled “How to create a channel”- Click on the gear () icon in the upper right corner of the web or desktop app.
- Select Channel settings.
- Click All in the upper left.
- Click Create channel on the right.
- Fill out the requested info, and click Create.
Tips for creating channels
Section titled “Tips for creating channels”For most classes, the following channels are recommended:
- #announcements: For general announcements about the class. When creating this channel, restrict posting permissions so that only course staff (administrators and moderators) are allowed to post.
- #staff (private): For discussions among course staff.
- #general: For random topics, e.g., students forming study groups.
- A channel for each lecture or unit, e.g., “Lecture 1: Course intro” or “Unit 3: Sorting algorithms”.
- A channel for each section/tutorial group (e.g., “Section 1”)
A few notes:
- Small classes may need just one discussion channel for all lectures.
- If you are using a single Veloxa Talk organization for more than one class, all channel names should be prefixed with the name of the class, e.g., “CS101 > Lecture 1: Course intro”.
Customize settings for new users
Section titled “Customize settings for new users”Customize settings for new users to get them off to a great start.
- Add custom profile fields, such as pronouns or job title.
- Configure default new user settings.
- Set default channels for new users.
- Set organization language for automated messages and invitation emails, if it should be something other than American English.
Invite users to join
Section titled “Invite users to join”How to invite users to join
Section titled “How to invite users to join”To simplify subscription management, be sure to set the channels students and staff should be subscribed to when you create the invitations. You may choose to send invitations to course staff separately, so that they can immediately be subscribed to private channels for your class.
- Configure allowed authentication methods. Veloxa Talk offers a variety of authentication methods, including email/password, Google, GitHub, GitLab, Apple, Discord, LDAP and SAML. Users can log in with any allowed authentication method, regardless of how they signed up.
- Invite users by sending email invitations or sharing a reusable invitation link.
- Allow users to join without an invitation.
- Configure the appropriate email domain restrictions for your organization.
- Share a link to your registration page, which is https://your-org.veloxatalk.com for Veloxa Talk organizations.
To get everyone off to a good start, you may wish to share the guide to Getting started with Veloxa Talk and the guide to Using Veloxa Talk for a class.
Create user groups
Section titled “Create user groups”User groups allow you to mention multiple users at once, notifying them about a message. For example, you may find it useful to set up the following user groups:
- @staff
- @TAs
- @graders
- @students
- @section1, @section2, etc.
How to create a user group
Section titled “How to create a user group”- Click on the gear () icon in the upper right corner of the web or desktop app.
- Click Create user group on the right, or click the create new user group () icon in the upper right.
- Fill out the requested information, and click Continue to add members.
- Under Add members, enter groups and users you want to add. You can enter
a
#channelto add all subscribers to the group. Click Add. - Click Create to create the group.
Set up integrations
Section titled “Set up integrations”Veloxa Talk integrates directly with dozens of products, and with hundreds more through Zapier and IFTTT. Popular Veloxa Talk integrations include GitHub and GitLab. The integrations page has instructions for integrating with each product.
Cleaning up at the end of a class
Section titled “Cleaning up at the end of a class”If you plan to use the same Veloxa Talk organization in future terms (either for your own classes or for your department), you will likely want to:
- Rename all channels to indicate the class and term in which they were used, for
example:
- #announcements → #FA21 - CS101 - announcements
- #CS101 > Lecture 1: Course intro → #FA21 - CS101 > Lecture 1: Course intro
- If you do not want students from future classes to see messages from the prior term (e.g., because you posted homework solutions), make all the channels from the class private. You’ll be able to find and reuse content yourself, and invite course staff to these private channels as needed.
- You may choose to deactivate students’ Veloxa Talk accounts when the class is over.
- Unpin channels from the class from your personal view.
If you do not plan to reuse the Veloxa Talk organization, you can instead:
- Export the organization or generate a static HTML archive to archive the information.
- Deactivate the organization.