Skip to content

A self-hosted media server and file management system

Merge branch 'main' into dev

Amin Nausin79f870ef5763
diff --cc .gitignore
index 12af397f,5e8c8724..3228197a
--- a/.gitignore
+++ b/.gitignore
@@@ -17,6 -17,7 +17,10 @@@ yarn-error.lo
/.fleet
/.idea
/.vscode
+/media/*
+/.vite/*
+/reference_headlessUI_2
+ storage/app/public/*
+ storage/debugbar/*
+ storage/framework/*
+ storage/logs/*
diff --cc README.md
index 23595867,c0969ebc..b86a46dc
--- a/README.md
+++ b/README.md
@@@ -7,28 -4,40 +7,28 @@@ It is still incomplete
Videos are grouped by folders and listed in a table with the file name and date.
This is good for a home server and provides fast and easy access to media.
-You can think of it as a fully self hosted Plex server without all the fluff.
-The website is responsive by design and works on mobile devices. HVEC support depends on the device used.
-
-## Installation
-
-### Requirements
-- Apache 2.4.x
-- PHP 8.x (Thread Safe)
-
-#### Setup
-- Install Apache Web Server
-- Install PHP 8
-- Set your document root to this folder in Apache's httpd.conf file.
-- Set up a port in Apache's httpd.conf file.
- - If you want to watch your media while outside your home, set up port forwarding on your router with this port number.
-- Create symbolic links in the resources folder that point to where videos are stored.
- - The default folder is defined on the second line of index.php as RESOURCE_DEFAULT. <br>
- It's shown when the user does not specify a folder in the URL.
-- Run apache and the website will show up on your Public IP Address and port number like {ip}:{port}
- - If you did not set up port forwarding, your Local IP Address will work the same way.
-- Optionally, you can set up Apache virtual hosts using the snippet provided in doc/setup to add security and support multiple websites on the same Apache server. It will prevent directory indexing, which allows anyone to browse your resources folder directly by default.
-
-#### Usage
-- The URL will be your public IP address, followed by the port used by your Apache server.
-- Different folders are accessed with ?dir=foldername after the website's URL.
-
-#### Supported File Types
+The website is responsive by design and works on mobile devices. HVEC support depends on the device used.
+
+### Installation
+
+Requires Apache or NGINX, PostgreSQL and PHP 8. You can use Laragon to run in a single application.
+
+To connect to your file server, create a Symbolic link between your remote location and ./storage/app/public/media
+To see any of your videos, you must run a file scan or start the Laravel CRON job which scans every 6 hours.
+You can run a file scan manually via the "Index Files" option in the dropdown under your username.
+
+Different folders are accessed via url/folder/subfolder. Using just URL/folder will open the first subfolder scanned.
+
+The default folder is defined on line 18 of ./routes/web.php as an automatic redirect to the default /folder/subfolder.
+This is shown when the user does not specify a folder.
+
+Supported File Types:
- MP4
- MKV
-<h6>You can support more file types by adding them to the FILE_TYPES array in the config.php file.</h6>
- ### Demo
+ ## Demo
- Screenshots of the current webpage on Desktop and on Android.
+ Below are screenshots of the current webpage on Desktop and Android.
!
!