Newer
Older
* Uncompressed video hosting, resulting in fast uploads and minuscule processing times
* Link-based video sharing, no public video searching and/or display
* Anonymous likes/dislikes
* Content management, cumulative video list
* Space management
* User stats
* Statistics
* Video list w/ video renaming, removal and link regeneration
* The application can now be accessed at localhost:10700
* The first registered user will be set as admin
* The registration page is accessible by pressing Alt+R while editing the username field in the landing/login page or by going to the regg route (https://hostname.domain/regg)
* **config.json file in the root directory with the following contents:**
> The config generator gets automatically launched after the initial installation. Be sure to fill everything in correctly! It can be rerun with `npm run setup`
1. `file_path` - video storage path, must also be served as static content, relative to the root dir
2. `session_key` - a random string, needed for the express-session module
3. `total_space` - the total amount of space you are willing to dedicate for the website. It will not allow any more registrations when the amount of reserved user space exceeds **(in bytes)**
4. `production_logging` - either "all", "error" or "none" - sets production-time logging severity
6. `self_hosted` - sets mode of operation:
* 1 - takes over ports 80 and 443, automatically generates TLS certs, must run as root.
* 2 - run on port defined in config, http only. Use when a routing system is setup(Apache, etc.)
7. `tls` - Letsencrypt options
8. `mail` - `username` and `password` - gmail account credentials, will be used for password resets
9. `databases` - `db_users_path`, `db_videos_path`,`db_codes_path` and `db_ratings_path` - database paths, relative to root dir. No need to change the default values.
10. `video_link_prefix` - set up the domain you want your website to be accessible through. Pay attention to HTTP and HTTPS, choose whichever is right for you!
* A config-example.json file is in the root dir with demo settings set. If needed, use it as guidance while filling out `npm run setup`
* Development:
* ``npm run dev`` runs the server in devmode
* Production:
* ``npm run build`` builds the server for production
* ``npm run start`` starts the built server
* Setup and maintenance:
* ``npm run setup`` or ``npm run config`` - starts the config generation sequence. Runs automatically after npm install.
* ``npm run codes`` opens the code manipulation console interface (upgrade and registration codes: space upgrades, admin status codes)
* ``npm run care`` or ``npm run maintenance`` - opens the maintenance console interface. Used for manually runnign tasks that check the integrity and health of the platform, as well as other operations, such as a complete wipe. A config.json must be present in order for these commands to work.
### Independant TLS precautions
* The server will most likely need to be ran as root, so it can take control of 80/443 ports
* This may in turn generate databases, temporary files and certs that have root ownership:
* Shouldn't be a problem if the TLS mode isn't changed
* System wipe will also need to be ran as root. When it's finished, normal non-root operation without auto TLS generation can be reinstated (after reconfiguring config.json via `npm run setup`).
### Automatic maintenance
* All unconfirmed videos (stored videos w/o confirmation & naming from the user) are removed
* All videos & thumbnails without entries in the database are purged
* Videos without a thumbnail get their thumbnails regenerated
* Total space is checked with current space. A **Warning** will be displayed on build if the total_space is exceeded (the system will still function, but uploads will no longer be accepted).