Skip to content

Docs: add dev section and selfstream#1815

Open
Mazi02 wants to merge 1 commit intodevfrom
docs/add-selfstream-page
Open

Docs: add dev section and selfstream#1815
Mazi02 wants to merge 1 commit intodevfrom
docs/add-selfstream-page

Conversation

@Mazi02
Copy link
Copy Markdown
Contributor

@Mazi02 Mazi02 commented Apr 25, 2026

Motivation and Context

A new section dedicated for development and contributing to the project. Like from setting up the project, running services and more.

Closes #1653

Description

Added a development section and a selfstream page for setting up everything locally and running the services using docker or local.

Steps for Testing

Prerequisites:

  • npm
  1. Navigate to docs_v2 folder
  2. run npm install and then npm run start

Screenshots

stream page

@Mazi02 Mazi02 requested review from SebiWrn and kordianbruck April 25, 2026 09:54
@Mazi02 Mazi02 changed the title add dev section and selfstream Docs: add dev section and selfstream Apr 25, 2026
@Mazi02 Mazi02 added the documentation Improvements or additions to documentation label Apr 25, 2026
- Start the db and meilisearch first. We use hybrid approach to run db and meilisearch in docker. You can run the following command to start them:

```bash
docker start meilisearch mariadb-tumlive
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only works if you already set up these containers once. Please provide more information on how to set them up for the first time


3. After creating the lecture you can click the `show keys` button to see the `URL` and `key`. Copy them into the streaming software of your choice.
4. Change the `tum.ingest.live/` to `localhost/`.
5. Start streaming, and you should see the stream in the admin section after a few seconds. You can also check the `meidamtx` logs to see if the stream is being ingested correctly.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
5. Start streaming, and you should see the stream in the admin section after a few seconds. You can also check the `meidamtx` logs to see if the stream is being ingested correctly.
5. Start streaming, and you should see the stream in the admin section after a few seconds. You can also check the `mediamtx` logs to see if the stream is being ingested correctly.


go run ./worker/edge
```
- Start the `meidamtx` server:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Start the `meidamtx` server:
- Start the `mediamtx` server:

# in the web/ directory

npm install
npm run buil-dev
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
npm run buil-dev
npm run build-dev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to run the self stream feature locally

2 participants