mirror of
https://github.com/filegator/filegator.git
synced 2025-10-23 23:16:22 +02:00
188 lines
9.5 KiB
HTML
188 lines
9.5 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>
|
||
|
||
|
||
<a href="https://github.com/filegator/filegator">
|
||
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png">
|
||
|
||
</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="active">
|
||
<a href="https://docs.filegator.io/development.html">
|
||
Development
|
||
</a>
|
||
</li>
|
||
<li class="">
|
||
<a href="https://docs.filegator.io/demo.html">
|
||
Demo
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
<p class="text-muted">
|
||
Configuration
|
||
</p>
|
||
|
||
<ul class="nav nav-pills nav-stacked">
|
||
<li class="">
|
||
<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="project-setup-for-development-linux">Project setup for development (Linux)</h2>
|
||
<p>You must have <code>git</code>, <code>php</code>, <code>npm</code>, and <code>composer</code> installed.</p>
|
||
<pre><code>git clone https://github.com/filegator/filegator.git
|
||
cd filegator
|
||
cp configuration_sample.php configuration.php
|
||
chmod -R 775 private/
|
||
chmod -R 775 repository/
|
||
composer install --ignore-platform-reqs
|
||
npm install
|
||
npm run build</code></pre>
|
||
<h2 id="compiles-and-hot-reloads">Compiles and hot-reloads</h2>
|
||
<p>The following command will launch backend and frontend on ports 8081 and 8080:</p>
|
||
<pre><code>npm run serve</code></pre>
|
||
<p>Once everything is ready visit: <code>http://localhost:8080</code></p>
|
||
<h2 id="run-tests-amp-static-analysis">Run tests & static analysis</h2>
|
||
<p>Testing requires xdebug, php-zip and sqlite php extensions.</p>
|
||
<pre><code>vendor/bin/phpunit
|
||
vendor/bin/phpstan analyse ./backend
|
||
npm run lint
|
||
npm run e2e</code></pre>
|
||
<h2 id="deployment">Deployment</h2>
|
||
<p>Set the website document root to <code>/dist</code> directory. This is also known as 'public' folder.</p>
|
||
<p>NOTE: For security reasons <code>/dist</code> is the ONLY folder you want to be exposed through the web. Everything else should be outside of your web root, this way people can’t access any of your important files through the browser.</p>
|
||
</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>
|