Files
truecharts/charts/incubator/rtmpserver/docs/installation_notes.md
Xstar97TheNoob 545c83f253 move charts to incubator (#9131)
**Description**
Move the following apps to incubator.

```
| Chart Name        | Chart Name  | Chart Name                 |
| ----------------- | ----------- | -------------------------- |
| authentik         | darktable   | guacamole-client           |
| cloudflared       | dsmr-reader | habridge                   |
| dupeguru          | filerun     | filezilla                  |
| firefox           | flashpaper  | focalboard                 |
| gotify            | grist       | icantbelieveitsnotvaletudo |
| icinga2           | inventree   | invidious                  |
| joplin-server     | k8s-gateway | kimai                      |
| koel              | kopia       | kutt                       |
| leantime          | libreoffice | librephotos                |
| linkace           | loki        | lychee                     |
| mattermost        | mealie      | miniflux                   |
| ml-workspace      | mosquitto   | nextcloud                  |
| openkm            | openldap    | penpot                     |
| photoview         | pialert     | piaware                    |
| pidgin            | pihole      | plexanisync                |
| protonmail-bridge | pydio-cells | recipes                    |
| rtmpserver        | sdtd        | shiori                     |
| snipe-it          | statping-ng | synapse                    |
| teamspeak3        | typecho     | wbo                        |
| wger              | wireshark   | zusam                      |
| xbackbone         | youtrack    |                            |
```
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

---------

Co-authored-by: xtar97 <dev.xtar97@gmail.com>
2023-05-24 19:03:16 +02:00

1.9 KiB

Installation Notes

The app has no configuration. The following is just a basic guide on how to stream and view the live stream.

Stream

  • This is the URL to use to stream rtmp://<server_ip>:1935/live/<stream_key>
    • Replace <server_ip> and <stream_key> respectively.
    • Change the port if its not default.

View

  • VLC

    • Go to Media > Open Network Stream. /code/charts/truecharts/charts/charts/rtmpserver - rtmp://<server ip>:1935/live/<stream-key>
  • Web

    • To play RTMP content: http://<server_ip>:10610/players/rtmp.html (requires Flash, this tech is dead!)
    • To play HLS content: http://<server_ip>:10610/players/hls.html
    • To play HLS content using hls.js library: http://<server_ip>:10610/players/hls_hlsjs.html
    • To play DASH content: http://<server_ip>:10610/players/dash.html
    • To play RTMP and HLS contents on the same page: http://<server_ip>:10610/players/rtmp_hls.html

:::note

The default basic builtin stream sites use a default key, "test".

:::

Customizaton

  • If you want to mount a modified version of a nginx.conf you can do so by manually mounting /etc/nginx/ as PVC or hostpath and then add the custom files after. Take a look at upstream's configs.

  • If you want to mount and customized the web players you can do so by mounting /usr/local/nginx/html/players and adding the files in that dir, here are example players htmls.

  • You might want to enable the codeserver addon to access the dirs to add/modify the files in a fast and easy to use web editor by going to http://<server_ip>:36107/?folder=/

:::note

We will not offer support if you manually mount these dirs, you can ask for help in our discord channel #🎓・unsupported-setups otherwise you can create a ticket in our support channel normally.

:::