chore: updated documentation with working video setup and sso guide #24

Saksham-Sirohi · 2025-07-11T15:37:42Z

Closes #21

Summary by Sourcery

Update development README with clarified launch instructions, video container setup, and SSO configuration guide.

Documentation:

Clarify application launch steps and ensure correct working directory notation
Add instructions for creating a video superuser and changing the video container port
Update ticket login URL to the correct path
Introduce SSO setup instructions including social app creation for the talk service
Fix troubleshooting section formatting and spelling

sourcery-ai · 2025-07-11T15:37:47Z

Reviewer's Guide

This PR overhauls the project documentation by migrating and consolidating setup instructions into README.md, enriching the launch workflow with video container and SSO configuration steps, updating access URLs, and correcting minor typos.

Flow diagram for SSO setup process

flowchart TD
    A[Login to Tickets] --> B[Enable Admin Mode]
    B --> C[Go to Admin > Global Settings]
    C --> D[Generate SSO Keys]
    D --> E[Use redirect URL: /talk/oauth2/callback/]
    E --> F[Enter Talk Container]
    F --> G[Run create_social_apps]
    G --> H[SSO enabled for Talk]

Flow diagram for video container setup and port configuration

flowchart TD
    A[Start eventyay-video container] --> B[Import sample config]
    B --> C[Create video superuser]
    C --> D[Change port in config.js from 8443 to 8375]
    D --> E[Access video at /control]

File-Level Changes

Change	Details	Files
Rename and consolidate documentation files	Rename README.development.md to README.md Remove outdated README file	`README.development.md` `README`
Clarify application launch instructions and formatting	Add note to remain in eventyay-docker directory Standardize code blocks using blockquotes	`README.md`
Add video container superuser setup and port configuration	Introduce commands to import config and create superuser for video Embed bash script to update port from 8443 to 8375 in config.js	`README.md`
Introduce SSO setup guide for talk system	Add steps to enable SSO keys in admin settings Include docker exec and manage.py create_social_apps commands	`README.md`
Update access URLs and fix minor typos	Change tickets login path to /tickets/login Add control URL for video access Fix typo in troubleshooting section	`README.md`

Assessment against linked issues

Issue	Objective	Addressed	Explanation

Possibly linked issues

Unify setup documentation for Eventyay all components #21: The PR merges README.development.md into README.md and adds video setup instructions, fulfilling the issue requirements.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @Saksham-Sirohi - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

Gagan-Ram · 2025-07-12T06:11:44Z

I got the below error when I tried to setup ey-video:
I ran "docker exec -it eventyay-video python3 manage.py import_config sample/worlds/sample.json"

Traceback (most recent call last):
File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 89, in _execute
return self.cursor.execute(sql, params)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
psycopg2.errors.UndefinedTable: relation "core_world" does not exist
LINE 1: ...ure_flags", "core_world"."external_auth_url" FROM "core_worl...
^
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
File "/venueless/server/manage.py", line 15, in
execute_from_command_line(sys.argv)
File "/usr/local/lib/python3.11/site-packages/django/core/management/init.py", line 442, in execute_from_command_line
utility.execute()
File "/usr/local/lib/python3.11/site-packages/django/core/management/init.py", line 436, in execute
self.fetch_command(subcommand).run_from_argv(self.argv)
File "/usr/local/lib/python3.11/site-packages/django/core/management/base.py", line 412, in run_from_argv
self.execute(*args, **cmd_options)
File "/usr/local/lib/python3.11/site-packages/django/core/management/base.py", line 458, in execute
output = self.handle(*args, **options)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/venueless/server/venueless/core/management/commands/import_config.py", line 17, in handle
import_config(world_data)
File "/usr/local/lib/python3.11/contextlib.py", line 81, in inner
return func(*args, **kwds)
^^^^^^^^^^^^^^^^^^^
File "/venueless/server/venueless/core/utils/config.py", line 19, in import_config
world, _ = World.objects.get_or_create(id=world_config.pop("id"))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/models/manager.py", line 87, in manager_method
return getattr(self.get_queryset(), name)(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 916, in get_or_create
return self.get(**kwargs), False
^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 633, in get
num = len(clone)
^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 380, in len
self._fetch_all()
File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 1881, in _fetch_all
self._result_cache = list(self._iterable_class(self))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 91, in iter
results = compiler.execute_sql(
^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/models/sql/compiler.py", line 1562, in execute_sql
cursor.execute(sql, params)
File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 67, in execute
return self._execute_with_wrappers(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 80, in _execute_with_wrappers
return executor(sql, params, many, context)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 84, in _execute
with self.db.wrap_database_errors:
File "/usr/local/lib/python3.11/site-packages/django/db/utils.py", line 91, in exit
raise dj_exc_value.with_traceback(traceback) from exc_value
File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 89, in _execute
return self.cursor.execute(sql, params)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
django.db.utils.ProgrammingError: relation "core_world" does not exist
LINE 1: ...ure_flags", "core_world"."external_auth_url" FROM "core_worl...

Saksham-Sirohi · 2025-07-12T08:13:52Z

I got the below error when I tried to setup ey-video: I ran "docker exec -it eventyay-video python3 manage.py import_config sample/worlds/sample.json"

Traceback (most recent call last): File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 89, in _execute return self.cursor.execute(sql, params) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ psycopg2.errors.UndefinedTable: relation "core_world" does not exist LINE 1: ...ure_flags", "core_world"."external_auth_url" FROM "core_worl... ^ The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/venueless/server/manage.py", line 15, in execute_from_command_line(sys.argv) File "/usr/local/lib/python3.11/site-packages/django/core/management/init.py", line 442, in execute_from_command_line utility.execute() File "/usr/local/lib/python3.11/site-packages/django/core/management/init.py", line 436, in execute self.fetch_command(subcommand).run_from_argv(self.argv) File "/usr/local/lib/python3.11/site-packages/django/core/management/base.py", line 412, in run_from_argv self.execute(*args, **cmd_options) File "/usr/local/lib/python3.11/site-packages/django/core/management/base.py", line 458, in execute output = self.handle(*args, **options) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/venueless/server/venueless/core/management/commands/import_config.py", line 17, in handle import_config(world_data) File "/usr/local/lib/python3.11/contextlib.py", line 81, in inner return func(*args, **kwds) ^^^^^^^^^^^^^^^^^^^ File "/venueless/server/venueless/core/utils/config.py", line 19, in import_config world, _ = World.objects.get_or_create(id=world_config.pop("id")) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/models/manager.py", line 87, in manager_method return getattr(self.get_queryset(), name)(*args, **kwargs) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 916, in get_or_create return self.get(**kwargs), False ^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 633, in get num = len(clone) ^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 380, in len self._fetch_all() File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 1881, in _fetch_all self._result_cache = list(self._iterable_class(self)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/models/query.py", line 91, in iter results = compiler.execute_sql( ^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/models/sql/compiler.py", line 1562, in execute_sql cursor.execute(sql, params) File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 67, in execute return self._execute_with_wrappers( ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 80, in _execute_with_wrappers return executor(sql, params, many, context) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 84, in _execute with self.db.wrap_database_errors: File "/usr/local/lib/python3.11/site-packages/django/db/utils.py", line 91, in exit raise dj_exc_value.with_traceback(traceback) from exc_value File "/usr/local/lib/python3.11/site-packages/django/db/backends/utils.py", line 89, in _execute return self.cursor.execute(sql, params) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ django.db.utils.ProgrammingError: relation "core_world" does not exist LINE 1: ...ure_flags", "core_world"."external_auth_url" FROM "core_worl...

The migrate command has been added now in order to fix this also, for initiating the sample file event loop is closed is expected

Gagan-Ram · 2025-07-12T08:15:57Z

Thank you, I can now access video component now

norbusan

Please also change the document which part is necessary for development and which part for actual deployment

README.md

sourcery-ai bot reviewed Jul 11, 2025

View reviewed changes

chore: updated documentation with working video setup and sso guide

2942bb8

Saksham-Sirohi force-pushed the new-documentation branch 4 times, most recently from 670e5f2 to 357b609 Compare July 11, 2025 17:20

prerequisite check and remove existing personal if it exists

18f3455

Saksham-Sirohi force-pushed the new-documentation branch from 357b609 to 18f3455 Compare July 11, 2025 18:18

added migration command for eventyay-video

505b38e

norbusan requested changes Jul 14, 2025

View reviewed changes

README.md Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Saksham-Sirohi force-pushed the new-documentation branch from 5c4f8e8 to 5fc8cbe Compare July 16, 2025 15:27

labelled specific steps for development purpose

0163e67

Saksham-Sirohi force-pushed the new-documentation branch from 5fc8cbe to 0163e67 Compare July 16, 2025 15:28

Saksham-Sirohi requested a review from norbusan July 16, 2025 15:29

Saksham-Sirohi force-pushed the new-documentation branch 2 times, most recently from 3caeb4b to ebcf17b Compare July 21, 2025 18:25

Added mac specific fixes to documentation

46bb65b

Saksham-Sirohi force-pushed the new-documentation branch from ebcf17b to 46bb65b Compare July 21, 2025 18:28

wsl change

25cf7e0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: updated documentation with working video setup and sso guide #24

chore: updated documentation with working video setup and sso guide #24

Uh oh!

Saksham-Sirohi commented Jul 11, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jul 11, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Gagan-Ram commented Jul 12, 2025 •

edited

Loading

Uh oh!

Saksham-Sirohi commented Jul 12, 2025

Uh oh!

Gagan-Ram commented Jul 12, 2025

Uh oh!

norbusan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chore: updated documentation with working video setup and sso guide #24

Are you sure you want to change the base?

chore: updated documentation with working video setup and sso guide #24

Uh oh!

Conversation

Saksham-Sirohi commented Jul 11, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Flow diagram for SSO setup process

Flow diagram for video container setup and port configuration

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Gagan-Ram commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Saksham-Sirohi commented Jul 12, 2025

Uh oh!

Gagan-Ram commented Jul 12, 2025

Uh oh!

norbusan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Saksham-Sirohi commented Jul 11, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jul 11, 2025 •

edited

Loading

Gagan-Ram commented Jul 12, 2025 •

edited

Loading