mirror of
https://github.com/filegator/filegator.git
synced 2025-08-02 20:07:41 +02:00
215 lines
11 KiB
HTML
215 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
<title>FileGator - Documentation</title>
|
|
|
|
<link rel="stylesheet" href="https://docs.filegator.io/css/bootstrap.min.css">
|
|
<link rel="stylesheet" href="https://docs.filegator.io/css/font-awesome.min.css">
|
|
<link rel="stylesheet" href="https://docs.filegator.io/css/highlight.tomorrow-night.css">
|
|
<link rel="stylesheet" href="https://docs.filegator.io/css/main.css">
|
|
</head>
|
|
<body>
|
|
|
|
<header class="navbar navbar-default navbar-fixed-top">
|
|
|
|
<a class="navbar-brand" href="https://docs.filegator.io/">
|
|
FileGator
|
|
<small class="hidden-xs hidden-sm">
|
|
Documentation
|
|
</small>
|
|
</a>
|
|
|
|
</header>
|
|
|
|
<main class="container-fluid">
|
|
<div class="row">
|
|
|
|
|
|
<nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
|
|
|
|
<p class="text-muted">
|
|
Getting Started
|
|
</p>
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/index.html">
|
|
What is FileGator
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/install.html">
|
|
Installation
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/accounts.html">
|
|
Users
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/development.html">
|
|
Development
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<p class="text-muted">
|
|
Configuration
|
|
</p>
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li class="active">
|
|
<a href="https://docs.filegator.io/configuration/basic.html">
|
|
Basic
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/configuration/auth.html">
|
|
Auth
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/configuration/session.html">
|
|
Session
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/configuration/storage.html">
|
|
Storage
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/configuration/logging.html">
|
|
Logging
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/configuration/security.html">
|
|
Security
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/configuration/router.html">
|
|
Router
|
|
</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/configuration/tmpfs.html">
|
|
Tmpfs
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<p class="text-muted">
|
|
Languages
|
|
</p>
|
|
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li class="">
|
|
<a href="https://docs.filegator.io/translations/default.html">
|
|
Translations
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
|
|
<section class="col-sm-offset-3 col-lg-offset-2 col-sm-9 col-lg-10">
|
|
<h2 id="basic">Basic</h2>
|
|
<p>All services are set with reasonable defaults. For regular users there is no need to change anything. The script should work out of the box.</p>
|
|
<p>You can edit <code>configuration.php</code> file to change the basic things like logo image, title, language and upload restrictions.</p>
|
|
<p>Note: if you've made a mistake in configuration file (forgot to close a quote?) the script will fail to load or throw an error. Please use provided default <code>configuration_sample.php</code> to put everything back to normal.</p>
|
|
<pre><code> 'frontend_config' => [
|
|
'app_name' => 'FileGator',
|
|
'app_version' => APP_VERSION,
|
|
'language' => 'english',
|
|
'logo' => 'https://filegator.io/filegator_logo.svg',
|
|
'upload_max_size' => 100 * 1024 * 1024, // 100MB
|
|
'upload_chunk_size' => 1 * 1024 * 1024, // 1MB
|
|
'upload_simultaneous' => 3,
|
|
'default_archive_name' => 'archive.zip',
|
|
'editable' => ['.txt', '.css', '.js', '.ts', '.html', '.php', '.json', '.md'],
|
|
'date_format' => 'YY/MM/DD hh:mm:ss', // see: https://momentjs.com/docs/#/displaying/format/
|
|
'guest_redirection' => '', // useful for external auth adapters
|
|
'search_simultaneous' => 5, // how many simultaneous getdirs to spawn when searching
|
|
|
|
// filter starts with separator => full path has to match, example: '/all/one/filegator/demo.txt'
|
|
// filter ends with separator => filter only folders (a file with the same name will be shown), example: '.git/'
|
|
// neither of above => it is a file and could be in every folder, example: '.htaccess'
|
|
// both of above => full folder path has to match, example: '/homes/web/filegator/.npm/'
|
|
'filter_entries' => ['Recycle.bin/', 'File System Information/', '.DS_Store', '@eaDir/', '#recycle/'],
|
|
|
|
// Use '' for the unlimited pagination and integers for the items per page. The first item is used as the
|
|
// default pagination and the choices are ordered by the order in the array.
|
|
'pagination' => ['', 5, 10, 15],
|
|
],</code></pre>
|
|
<h2 id="additional-html">Additional HTML</h2>
|
|
<p>You can add additional html to the head and body like this:</p>
|
|
<pre><code> 'Filegator\Services\View\ViewInterface' => [
|
|
'handler' => '\Filegator\Services\View\Adapters\Vuejs',
|
|
'config' => [
|
|
'add_to_head' => '<meta name="author" content="something">',
|
|
'add_to_body' => '<script src="http://example.com/analytics.js"></script>',
|
|
],
|
|
],</code></pre>
|
|
<h2 id="frontend-tweaks">Frontend tweaks</h2>
|
|
<p>To change default color scheme and other options, edit <code>frontend/App.vue</code> When you're done, recompile with <code>npm run build</code> like described <a href="/development.html">here</a></p>
|
|
<pre><code>// Primary color
|
|
$primary: #34B891;
|
|
$primary-invert: findColorInvert($primary);
|
|
|
|
$colors: (
|
|
"primary": ($primary, $primary-invert),
|
|
"info": ($info, $info-invert),
|
|
"success": ($success, $success-invert),
|
|
"warning": ($warning, $warning-invert),
|
|
"danger": ($danger, $danger-invert),
|
|
);
|
|
|
|
// Links
|
|
$link: $primary;
|
|
$link-invert: $primary-invert;
|
|
$link-focus-border: $primary;
|
|
|
|
// Disable the widescreen breakpoint
|
|
$widescreen-enabled: false;
|
|
|
|
// Disable the fullhd breakpoint
|
|
$fullhd-enabled: false;</code></pre>
|
|
</section>
|
|
|
|
</div>
|
|
</main>
|
|
|
|
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
|
|
<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
|
|
<script src="//yandex.st/highlightjs/7.5/highlight.min.js"></script>
|
|
|
|
<script>
|
|
$(function() {
|
|
$("section>h1").wrap('<div class="page-header" />');
|
|
// Syntax highlighting
|
|
hljs.initHighlightingOnLoad();
|
|
});
|
|
</script>
|
|
|
|
<!-- Ticksel analytics v1.0 -->
|
|
<script type="text/javascript">
|
|
var _tcfg = _tcfg || [];
|
|
(function() {
|
|
_tcfg.push(["tags", "filegator-io,filegator-io-docs"]);
|
|
var u="https://a.interactive32.com/js/safetick.js"; _tcfg.push(["account_id", 8348834]);
|
|
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0];
|
|
g.type="text/javascript"; g.async=true; g.src=u; g.setAttribute("crossorigin", "anonymous");
|
|
s.parentNode.insertBefore(g,s);
|
|
})();
|
|
</script>
|
|
<noscript><img src="https://a.interactive32.com/beam?account_id=8348834&referrer=&tags=filegator-io,filegator-io-docs" style="border:0;" width="0" height="0" alt="" /></noscript>
|
|
<!-- End Ticksel Code -->
|
|
|
|
</body>
|
|
</html>
|