README
¶
简体中文 | English
Sponsor
Olived | A modern live stream recorder
Installation
-
build from source
go install github.com/go-olive/olive@latest -
download from releases
-
docker image
docker pull luxcgo/olive
Quickstart
Get olive to work simply by passing the live url.
$ olive run -u https://www.huya.com/518512
Usage
$ olive help
olive is a live stream recorder, underneath there is a powerful engine
which monitors streamers status and automatically records when they're
online. It helps you catch every live stream you want to see.
Usage:
olive [command]
Available Commands:
admin Admin is a cli utility for database.
biliup Biliup is a cli utility which generates bilibli cookies.
completion Generate the autocompletion script for the specified shell
help Help about any command
run Start the olive engine.
server Server provides olive-api support.
tv TV is a cli utility which gets stream url.
version Print the version number of olive
Flags:
-h, --help help for olive
Use "olive [command] --help" for more information about a command.
License
This project is under the Apache-2.0. See the LICENSE file for the full license text.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
services/olive-api/handlers
Package handlers contains the full set of handler functions and routes supported by the web api.
|
Package handlers contains the full set of handler functions and routes supported by the web api. |
|
services/olive-api/handlers/debug/checkgrp
Package checkgrp maintains the group of handlers for health checking.
|
Package checkgrp maintains the group of handlers for health checking. |
|
services/olive-api/handlers/v1
Package v1 contains the full set of handler functions and routes supported by the v1 web api.
|
Package v1 contains the full set of handler functions and routes supported by the v1 web api. |
|
services/olive-api/handlers/v1/configgrp
Package configgrp maintains the group of handlers for config access.
|
Package configgrp maintains the group of handlers for config access. |
|
services/olive-api/handlers/v1/showgrp
Package showgrp maintains the group of handlers for show access.
|
Package showgrp maintains the group of handlers for show access. |
|
tooling/logfmt
This program takes the structured log output and makes it readable.
|
This program takes the structured log output and makes it readable. |
|
tooling/olive-admin
This program performs administrative tasks for the olive service.
|
This program performs administrative tasks for the olive service. |
|
tooling/olive-admin/commands
Package commands contains the functionality for the set of commands currently supported by the CLI tooling.
|
Package commands contains the functionality for the set of commands currently supported by the CLI tooling. |
|
business
|
|
|
core/config
Package config provides business API for config.
|
Package config provides business API for config. |
|
core/config/db
Package db contains config related CRUD functionality.
|
Package db contains config related CRUD functionality. |
|
core/show
Package show provides business API for show.
|
Package show provides business API for show. |
|
core/show/db
Package db contains show related CRUD functionality.
|
Package db contains show related CRUD functionality. |
|
data/dbschema
Package dbschema contains the database schema, migrations and seeding data.
|
Package dbschema contains the database schema, migrations and seeding data. |
|
data/dbtest
Package dbtest contains supporting code for running tests that hit the DB.
|
Package dbtest contains supporting code for running tests that hit the DB. |
|
sys/database
Package database provides support for access the database.
|
Package database provides support for access the database. |
|
sys/validate
Package validate contains the support for validating models.
|
Package validate contains the support for validating models. |
|
web/v1
Package v1 represents types used by the web application for v1.
|
Package v1 represents types used by the web application for v1. |
|
web/v1/mid
Package mid contains the set of middleware functions.
|
Package mid contains the set of middleware functions. |
|
Package command defines and implements command-line commands and flags used by olive.
|
Package command defines and implements command-line commands and flags used by olive. |
|
engine
|
|
|
config
Package config stores config type.
|
Package config stores config type. |
|
dispatcher
Package dispatcher handles bout events.
|
Package dispatcher handles bout events. |
|
kernel
Package kernel is the core of olive.
|
Package kernel is the core of olive. |
|
log
Package l support a convenient logger for engine.
|
Package l support a convenient logger for engine. |
|
monitor
Package monitor monitors streams.
|
Package monitor monitors streams. |
|
parser
Package parser provides support for downloading streams.
|
Package parser provides support for downloading streams. |
|
recorder
Package recorder records streams.
|
Package recorder records streams. |
|
uploader
Package uploader handles post cmds when show ends.
|
Package uploader handles post cmds when show ends. |
|
foundation
|
|
|
biliup
Package biliup provides support for uploading videos to bilibili.
|
Package biliup provides support for uploading videos to bilibili. |
|
docker
Package docker provides support for starting and stopping docker containers for running tests.
|
Package docker provides support for starting and stopping docker containers for running tests. |
|
logger
Package logger provides a convenience function to constructing a logger for use.
|
Package logger provides a convenience function to constructing a logger for use. |
|
olivetv
Package olivetv provides support for retrieving stream urls and other streamers' details.
|
Package olivetv provides support for retrieving stream urls and other streamers' details. |
|
syncmap
Package syncmap implements a generic thread safe map.
|
Package syncmap implements a generic thread safe map. |
|
web
Package web contains a small web framework extension.
|
Package web contains a small web framework extension. |
Click to show internal directories.
Click to hide internal directories.