1. Войдите как преподаватель
Откройте личную ссылку входа, полученную от владельца сервера. Она имеет вид https://ваш-сервер/admin/k/… и открывает панель преподавателя. Пароль и почтовое подтверждение не нужны.
Если вы впервые настраиваете собственный сервер, откройте ссылку /admin/t/…: пока у сервера нет владельца, он печатает её в журнал при каждом запуске. Можно и открыть /admin и вставить токен настройки вручную. Токен хранится в DATA_DIR/setup-token: в стандартной установке k3s это /var/lib/colloq/data/setup-token, при установке через pip install colloq — ~/.colloq/data/setup-token. Введите имя и почту и нажмите «Стать владельцем». Этот же токен позволяет восстановить доступ позже.
В этой документации названия кнопок приведены для русского интерфейса. Владелец может выбрать русский или английский для всего сервера.
2. Создайте занятие
В панели откройте раздел «Занятия» и нажмите «Новое занятие». Задайте название, выберите окружение Python, стартовую тетрадь («Пустая тетрадь», «Из файла» или «Из GitHub» — только публичные репозитории) и формат. В разделе «Ресурсы» можно задать память и число процессорных ядер для ядра комнаты. Память можно поднять и во время занятия через «Настройки» в меню занятия — ядро при этом не перезапускается ни в Docker, ни в установке на k3s. Подробности — в разделе «Память и процессор занятия».
| Формат | Начальные правила | Когда выбрать |
|---|---|---|
| Обычный | Группа редактирует общую тетрадь и запускает код. | Практика и совместный разбор. |
| Лекция | Редактирование, запуск, состав тетради и файлы — у преподавателя; отдельные ячейки он открывает группе. | Объяснение с демонстрацией. |
| Консилиум | Правила лекции; открытие ячейки выдаёт каждому свой лист. | Задача с последующим обсуждением ответов. |
Это начальные наборы правил. Их можно менять по ходу занятия. Доступ к оракулу — «Как настроено для инстанса», «Выключен», «Только подсказки» или «Полные ответы» — выбирается при создании в пределах режима сервера; изменить его после создания нельзя.
3. Подготовьте рабочее место
- Добавьте код и пояснения в тетрадь; при необходимости загрузите ноутбук и данные.
- Запустите подготовительные ячейки. Убедитесь, что нужные библиотеки доступны в выбранном окружении.
- Проверьте права студентов: редактирование, исполнение, файлы, оракул и общий экран.
- Откройте ссылку занятия в отдельном приватном окне и войдите как студент. Проверьте именно этот вид перед началом пары.
Для лекции заранее загрузите PDF и проверьте проектор и пульт. Для Консилиума выполните общий подготовительный код до открытия задания.
4. Пригласите группу
Скопируйте ссылку занятия из панели и отправьте её в чат группы. Студенту достаточно открыть её в браузере и ввести имя. Устанавливать Python на студенческие компьютеры не требуется: код выполняется на сервере.
Если в ссылке оказался localhost, сначала исправьте внешний адрес сервера. На своём компьютере colloq start --share даёт занятию публичный адрес и печатает ссылку для рассылки (одна ссылка). Проверьте открытие ссылки с другой сети, а не только с преподавательского ноутбука.
5. Завершите занятие
В комнате нажмите кнопку с замком «Что можно делать в комнате», затем «Закончить занятие»; в панели то же действие — «Завершить занятие» в меню занятия. Студенты смогут перечитать материалы, файлы, историю терминала и ответы оракула, но активные действия останутся преподавателю. «Продолжить занятие» вернёт исходные правила.
Для отдельной страницы чтения используйте публикацию. Завершение занятия, публикация и удаление комнаты — разные действия.
Доступ других преподавателей
Владелец добавляет преподавателя в разделе «Преподаватели» кнопкой «Добавить преподавателя»: имя и почта нужны для идентификации, Colloq не отправляет писем. Передайте созданную ссылку для входа лично. Если ссылка потеряна или стала доступна посторонним, нажмите «Заменить ссылку для входа» в строке преподавателя: прежняя ссылка и открытые с ней сеансы перестанут работать.