LogalDeveloper/owncast
0
Fork 0
Code Activity

Update Owncast developer documentation to mention Windows #2864 (#2883)

Browse Source 
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Create owncast_for_windows.md

* Update README.md

* Update README.md

* Update owncast_for_windows.md

* Update README.md

* Update owncast_for_windows.md

More clarity about different use cases
Added steps for installing Owncast as a user in Windows.

* Update owncast_for_windows.md

Changing the format a little bit

* Update owncast_for_windows.md
This commit is contained in:
Dev Gupta
2023-04-04 06:47:32 +05:30
committed by GitHub
parent 1cd4efaf72
commit 931772d850
2 changed files with 151 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -69,16 +69,15 @@ The goal is to have a single service that you can run and it works out of the bo
## Use with your existing broadcasting software
In general Owncast is compatible with any software that uses `RTMP` to broadcast to a remote server. `RTMP` is what all the major live streaming services use, so if you’re currently using one of those it’s likely that you can point your existing software at your Owncast instance instead.
In general, Owncast is compatible with any software that uses `RTMP` to broadcast to a remote server. `RTMP` is what all the major live streaming services use, so if you’re currently using one of those it’s likely that you can point your existing software at your Owncast instance instead.
OBS, Streamlabs, Restream and many others have been used with Owncast. [Read more about compatibility with existing software](https://owncast.online/docs/broadcasting/).
## Building from Source
Owncast consists of two projects.
1. The Owncast backend written in Go.
1. The frontend written in React.
1. The Owncast backend is written in Go.
1. The frontend is written in React.
[Read more about running from source](https://owncast.online/development/).
@@ -86,16 +85,18 @@ Owncast consists of two projects.
The `develop` branch is always the most up-to-date state of development and this may not be what you always want. If you want to run the latest released stable version, check out the tag related to that release. For example, if you'd only like the source prior to the v0.1.0 development cycle you can check out the `v0.0.13` tag.
> Note: Currently Owncast only supports Linux based Operating Systems, but Windows Users can use Windows Subsystem for Linux (WSL2) to install Owncast. For more details you can check out this [Owncast-for-windows](https://github.com/owncast/owncast/blob/develop/owncast_for_windows.md)
### Backend
The Owncast backend is a service written in Go.
1. Ensure you have pre-requisites installed.
1. Ensure you have prerequisites installed.
- C compiler, such as [GCC compiler](https://gcc.gnu.org/install/download.html) or a [Musl-compatible compiler](https://musl.libc.org/)
- [ffmpeg](https://ffmpeg.org/download.html)
1. Install the [Go toolchain](https://golang.org/dl/) (1.18 or above).
1. Clone the repo. `git clone https://github.com/owncast/owncast`
1. `go run main.go` will run from source.
1. `go run main.go` will run from the source.
1. Visit `http://yourserver:8080` to access the web interface or `http://yourserver:8080/admin` to access the admin.
1. Point your [broadcasting software](https://owncast.online/docs/broadcasting/) at your new server and start streaming.
@@ -107,6 +108,7 @@ The frontend is the web interface that includes the player, chat, embed componen
1. Run `npm install` to install the Javascript dependencies.
1. Run `npm run dev`
## Contributing
Owncast is a growing open source project that is giving freedom, flexibility and fun to live streamers.