README
¶
This is all pre-release code, continue at your own peril.
What is Olaris?
Olaris is an open-source, community driven, media manager and transcoding server. The main interface is the olaris-react project although in due time we hope to support multiple clients / applications.
Our core values are:
Community driven development
We want Olaris to be a community project which means we will heavily prioritise features based on our user feedback.
Focus on one feature at a time
We will work on features until they are perfect (or as close to it as possible). We would rather have a product where three features work really well than a product with 30 unfinished features.
This does not mean we won't work in parallel, it simply means we will not start anything new until we are happy the new feature works to a high standard.
Our users are not our product
We don't want to collect metadata, we don't want to sell metadata your data is yours and yours alone.
Singular Focus: Video.
Our sole focus is on video and video alone, anything that does not meet this requirement will not be considered. This means for example we will never add music support due to different approach that would be required throughout the application.
Open-source
Everything we build should be open-source. We feel strongly that more can be achieved with free open-source software. That's why were are aiming to be and to remain open-source instead of open-core where certain features are locked behind a paywall.
Setting up a build environment
Build dependencies
- Install the Go toolchain
- go get github.com/jteeuwen/go-bindata/...
- go get github.com/elazarl/go-bindata-assetfs/...
- Build our custom ffmpeg
Make commands
make run to run a build on your local platform.
make build to build a binary for your local platform.
build-with-react to build and pull in the latest web-interface this requires the build toolchain for olaris-react.
make list for all make options
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Convenience wrapper around ffmpeg as a transcoder to DASH chunks https://github.com/go-cmd/cmd/blob/master/cmd.go was very useful while writing this module.
|
Convenience wrapper around ffmpeg as a transcoder to DASH chunks https://github.com/go-cmd/cmd/blob/master/cmd.go was very useful while writing this module. |
|
Package metadata implements metadata server features such as media indexing, media metadata lookup on external services and exposing this data via APIs.
|
Package metadata implements metadata server features such as media indexing, media metadata lookup on external services and exposing this data via APIs. |
|
app
Package app wraps all other important packages.
|
Package app wraps all other important packages. |
|
auth
Package auth handles various authentication methods for the metadata server.
|
Package auth handles various authentication methods for the metadata server. |
|
db
Package db handles database queries for the metadata server
|
Package db handles database queries for the metadata server |
|
helpers
Package helpers has a collection of helpers that help process metadata details.
|
Package helpers has a collection of helpers that help process metadata details. |
|
parsers
Package parsers has a collection of parsers that can extract useful information out of filenames.
|
Package parsers has a collection of parsers that can extract useful information out of filenames. |
|
resolvers
Package resolvers implements resolvers for the GraphQL interface.
|
Package resolvers implements resolvers for the GraphQL interface. |
|
Package react is a handler for the olaris-react application.
|
Package react is a handler for the olaris-react application. |