You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-9Lines changed: 41 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,36 +3,68 @@ MistServer
3
3
4
4
MistServer is an open source, public domain, full-featured, next-generation streaming media toolkit for OTT (internet streaming), designed to be ideal for developers and system integrators.
5
5
6
-
For full documentation, tutorials, guides and assistance, please look on our website at: https://mistserver.org
6
+
For full documentation, see: https://docs.mistserver.org
7
+
8
+
For support and assistance, please look on our website at: https://mistserver.org
7
9
8
10
Getting MistServer onto your system
9
11
===================================
10
12
11
-
We provide precompiled binaries for most common operating systems here: https://mistserver.org/download
13
+
We provide pre-compiled binaries for most common operating systems here: https://mistserver.org/download
12
14
13
15
Using the "Copy install cmd" button will give you a command you can paste into a terminal to set up MistServer running as root under your system's init daemon (systemd recommended, but not required).
14
16
15
-
You can also manually install, will instructions can be found in our manual: https://mistserver.org/guides/latest
17
+
You can also manually install, full instructions can be found in our manual: https://docs.mistserver.org/category/installation
16
18
17
19
Compile instructions
18
20
====================
19
21
20
-
We make use of cmake for compilation. The default configuration requires mbedtls and libsrtp2 to be installed on your system.
22
+
The recommended build system for compiling MistServer is Meson.
23
+
24
+
The project makes full use of Meson's support for "wraps" and all dependencies can be automatically fulfilled through this system. If a system-wide library is available (and compatible), that one will be preferred.
25
+
26
+
The following command will create a subdirectory named `build` and set it up for compiling MistServer (assuming meson is installed on your system):
27
+
28
+
```
29
+
meson setup build
30
+
```
31
+
32
+
The default options should suffice in most cases, but a full list of possible compile options can be found by running `meson configure`.
21
33
22
-
The version of mbedtls we require is a specific branch that supports DTLS and SRTP for WebRTC, which can be found here: https://github.com/livepeer/mbedtls/tree/dtls_srtp_support
34
+
Then, to actually build:
23
35
24
-
All compilaton options can be discovered and set through `cmake-gui`; more complete compile instructions will follow soon.
36
+
```
37
+
cd build
38
+
ninja
39
+
```
40
+
41
+
That should compile MistServer to your build directory, and it can then be ran by running:
42
+
43
+
```
44
+
./MistController
45
+
```
46
+
47
+
See the "Usage" chapter below for more details on actually running MistServer.
48
+
MistServer can be in any directory, as long as all its binaries (that you want/need) are in one directory together.
49
+
You can (optionally) install system-wide (usually requires you to be root user or using `sudo`) by running:
50
+
51
+
```
52
+
ninja install
53
+
```
25
54
26
55
Usage
27
56
=====
28
57
29
-
MistServer is booted by starting the `MistController` binary, which then scans the directory it is stored in for further `Mist*` binaries and runs them to discover what inputs/outputs/processes are available.
58
+
MistServer is booted by starting the `MistController` binary, which then scans the directory it is stored in for further `Mist*` binaries and runs them to discover what inputs/outputs/processes are available. (Yes, this means you can delete any binary you don't want/need and it will just do what you expect/want.)
30
59
31
-
Running the controller in a terminal will walk you through a brief first-time setup, and then listen on port 4242 for API connections. Accessing port 4242 from a web browser will bring up a web interface capable of easily running most API commands for human-friendly configuration.
60
+
Running the controller in a terminal will walk you through a brief first-time setup, and then listen on port 4242 for API connections.
61
+
Accessing port 4242 from a web browser will bring up a web interface capable of easily running most API commands for human-friendly configuration.
62
+
If there is no interactive terminal when MistServer is first started, the first-time setup can be completed using the web interface instead.
32
63
33
-
Full usage instructions and API specifications can be found in the manual: https://mistserver.org/guides/latest
64
+
Full usage instructions and API specifications can be found in the online manual: https://docs.mistserver.org/
34
65
35
66
Contributing
36
67
============
37
68
38
69
If you're interested in contributing to MistServer development, please reach out to us through info@mistserver.org. Full contribution guidelines will be made available soon.
0 commit comments