1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/tube_ynh.git synced 2024-09-04 01:46:11 +02:00
tube_ynh/README.md

74 lines
3 KiB
Markdown
Raw Normal View History

2022-08-27 00:04:19 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2022-08-27 00:04:27 +02:00
# Tube for YunoHost
2022-08-27 00:04:19 +02:00
2022-08-27 00:04:27 +02:00
[![Integration level](https://dash.yunohost.org/integration/tube.svg)](https://dash.yunohost.org/appci/app/tube) ![Working status](https://ci-apps.yunohost.org/ci/badges/tube.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/tube.maintain.svg)
[![Install Tube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tube)
2022-08-27 00:04:19 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-08-27 00:04:27 +02:00
> *This package allows you to install Tube quickly and simply on a YunoHost server.
2022-08-27 00:04:19 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-08-27 00:04:27 +02:00
tube is a Youtube-like (without censorship and features you don't need!) Video Sharing App written in Go which also supports automatic transcoding to MP4 H.265 AAC, multiple collections and RSS feed.
2022-08-27 00:04:19 +02:00
### Features
2022-08-27 00:04:27 +02:00
- Easy to add videos (just move a file into the folder)
- Easy to upload videos (just use the builtin uploader and automatic transcoder!)
- Builtin ffmpeg-based Transcoder that automatically converts your uploaded content to MP4 H.264 / AAC
- Builtin automatic thumbnail generator
- No database (video info pulled from file metadata)
2022-08-27 07:18:29 +02:00
- No JavaScript (the player UI is entirely HTML, except for the uploader which degrades!)
2022-08-27 00:04:27 +02:00
- Easy to customize CSS and HTML template
- Automatically generates RSS feed (at /feed.xml)
- Clean, simple, familiar UI
2022-08-27 00:04:19 +02:00
2022-08-27 00:12:18 +02:00
**Shipped version:** 1.1.13~ynh1
2022-08-27 00:04:19 +02:00
2022-08-27 00:04:27 +02:00
**Demo:** https://tube.mills.io
2022-08-27 00:04:19 +02:00
2022-08-27 00:04:27 +02:00
## Screenshots
2022-08-27 00:04:19 +02:00
2022-08-27 00:04:27 +02:00
![Screenshot of Tube](./doc/screenshots/screenshot-1.png)
2022-08-27 00:04:19 +02:00
2022-08-27 07:36:50 +02:00
## Disclaimers / important information
## Configuration
#### Where are stored your videos
Your video files are stored by default in `/home/yunohost.app/tube/videos`.
You can configure options in this file `/var/www/tube/config.json` using the [documentation](https://git.mills.io/prologic/tube#configuration). Remember to restart Tube service if you change your configuration file.
2022-08-27 11:59:31 +02:00
RSS feed address is available at `https://your_domain.tld/feed.xml`
2022-08-27 08:21:30 +02:00
2022-08-27 14:51:09 +02:00
The data directory with uploaded videos is untouched when upgrading the app. If you want to delete the data directory with the application, use the `--purge` option: `sudo yunohost app remove tube --purge`
2022-08-27 00:04:19 +02:00
## Documentation and resources
2022-08-27 00:04:27 +02:00
* Upstream app code repository: <https://git.mills.io/prologic/tube>
* YunoHost documentation for this app: <https://yunohost.org/app_tube>
* Report a bug: <https://github.com/YunoHost-Apps/tube_ynh/issues>
2022-08-27 00:04:19 +02:00
## Developer info
2022-08-27 00:04:27 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/tube_ynh/tree/testing).
2022-08-27 00:04:19 +02:00
To try the testing branch, please proceed like that.
``` bash
2022-08-27 00:04:27 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/tube_ynh/tree/testing --debug
2022-08-27 00:04:19 +02:00
or
2022-08-27 00:04:27 +02:00
sudo yunohost app upgrade tube -u https://github.com/YunoHost-Apps/tube_ynh/tree/testing --debug
2022-08-27 00:04:19 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>