- File browser
- File sharing
- Misc features
- File sharing with an expiry date
- Formatted embeds
- Customisable accent colour
- Customisable page name
- PHP 8.0+
- Composer
- MySQL/MariaDB
- FFMPEG
To install this program, download the latest version from this repository.
Place the files in the desired location, preferably in a directory accessable by the web server.
Now run the following command in the directory containing the files to initialise the setup.
php setup.phpYou will be asked a few questions during the setup process like so:
Note: The setup will output some text to the console that will requre you to copy and configure for your own web server.
If you wish to change any of the settings you can run the same command to do so. If you want to setup a specific part again then you can run the command with -configure <part> like so:
php setup.php -configure webserver
To update the program, download the latest release from this repository and place the archived folder named dist.zip in the root of the directory where your current install is located.
Then run the following command to update the program:
unzip -o dist.zip
cp -r dist/* ./
rm -rf distIf any configuration or database changes are required there will be a script located in _updates that you will need to run named <old_version>_to_<new_version>.php.
This can be done as seen in the following example:
php _updates/1.0.0_to_1.1.0.phpYou may be prompted to enter some values when running these scripts.
If the installation fails then you may need to manually install the updates.
Currently there is no easy way to manually update the program as it will require you to read the source code and manually update the files. However in the future I may, if possible, comment the manual steps needed if the script fails.
Note: It is important that the update scripts are run in the correct order. For example if you are on version 1.0.0 and you want to update to version 2.0.0 and there are update scrips for 1.1.0 and so on then you should run those scripts first. If your old version is newer than the oldest version named on an update script then run the latest update script, for example if your previous version was 1.0.5, your new version is 2.0.0 and the latest update script you have is 1.0.1_to_2.0.0.php then you should run this script.
Note: It is also important that the update scripts are not run more than once as it may cause unexpected behaviour and break the program.
Once you have installed and set up the program, you should be able to access the page from your webserver.
The first thing you should do is log into the default admin account with the username admin and the password AdminUser01.
Note: The default admin account is only used for the initial setup and is not intended to be used for normal use, it is highly advised that you change the password for the default admin account.
You can create and manage accounts from the admin page, this page is only accessible by admin users.
Usernames must be between 4 and 20 characters long and contain only letters, numbers and underscores, once an account is created the username cannot be changed.
Passwords must be between 8 and 32 characters long and contain at least one uppercase and lowercase letter and at least one number character.
Administrative privileges can be given to accounts when creating or updating them.
Paths are the "root" folders that the website will use to read files from the system.
To add and manage paths, go to the admin page and click the Paths tab.
The web path is the path that will be accessed from the website and must only contain letters.
The local path is the path that will be accessed from the server, this path must be a valid directory on the server.
You can browse files from the website by clicking on the Files tab.
Note: Only registered users can access the file browser unless the url is to a public file or folder.
Files can be shared to the public with or without an expiry date.
To share a file, navigate to the Files tab and click the share button on the file or folder you wish to share.
Note: The root folders cannot be shared.
When sharing a file or folder, you can specify choose to add an expiry date to the share.
To access the shared file or folder, copy the link from the sharing menu and paste it into the address bar of your browser, the page has been designed so that the parent folders of the shared file or folder will not be exposed to the public.
Optional features:
- Sharing files with google users, please read here for more information.
- Add support for creating, editing and deleting files
- Add support for creating, editing and deleting folders
- Add support for uploading files and folders
This version of the api is rather basic but is functional.
All requests return JSON data unless it is for a file.
If an error occurs, the response will contain a JSON message with the error.
{
"error": "<ERROR_MESSSSAGE>"
}Below are all the possible error messages:
INVALID_PATH
NO_RESPONSE
METHOD_NOT_ALLOWED
DIRECT_REQUEST_NOT_ALLOWED
INVALID_PARAMETERS
INVALID_ACCOUNT_DATA
ACCOUNT_ALREADY_EXISTS
ACCOUNT_NOT_FOUND
PATH_ALREADY_EXISTS
DATABASE_ERROR
THUMBNAL_ERROR
INVALID_FILE_TYPE
SHARE_EXPIRED
UNKNOWN_ERROR
GAPI_NOT_CONFIGURED
GOOGLE_AUTHENTICATION_REQUIRED
API V1 supports the following requests:
Documentation is in progress
If you have any questions, please contact me on Discord (Readie#6594) or GitHub. If your inquiry is issue or feature related, please create an issue on GitHub.