Website generation with Couscous

This commit is contained in:
Milos Stojanovic
2019-06-18 18:37:41 +02:00
parent 67e392dd88
commit 86a6e4db44
6 changed files with 16 additions and 15 deletions

View File

@@ -102,8 +102,8 @@
<section class="col-sm-offset-3 col-lg-offset-2 col-sm-9 col-lg-10">
<h2 id="default-auth-service">Default Auth service</h2>
<p>By default, users are stored in json file. For some use-cases, this is more than enough. It also makes this app lightweight since no database is required.</p>
<p>Default handler accepts only file name parameter. This file should be writable by the server.</p>
<p>By default, users are stored in json file. For some use-cases, this is enough. It also makes this app lightweight since no database is required.</p>
<p>Default handler accepts only file name parameter. This file should be writable by the web server.</p>
<pre><code> 'Filegator\Services\Auth\AuthInterface' =&gt; [
'handler' =&gt; '\Filegator\Services\Auth\Adapters\JsonFile',
'config' =&gt; [
@@ -112,7 +112,7 @@
],
</code></pre>
<h2 id="configuring-auth-service-to-use-database">Configuring Auth service to use database</h2>
<p>You can use mysql database to store your users.</p>
<p>You can also mysql database to store your users.</p>
<p>First, create a table <code>users</code> with this sql:</p>
<pre><code>CREATE TABLE `users` (
`id` int(10) NOT NULL AUTO_INCREMENT,
@@ -130,7 +130,7 @@
VALUES
('guest', 'Guest', 'guest', '', '/', ''),
('admin', 'Admin', 'admin', 'read|write|upload|download|batchdownload|zip', '/', '$2y$10$Nu35w4pteLfc7BDCIkDPkecjw8wsH8Y2GMfIewUbXLT7zzW6WOxwq');</code></pre>
<p>At the end, open <code>configuration.php</code> and update Auth handler under section <code>services</code> to something like this:</p>
<p>At the end, open <code>configuration.php</code> and update AuthInterface handler to:</p>
<pre><code> 'Filegator\Services\Auth\AuthInterface' =&gt; [
'handler' =&gt; '\Filegator\Services\Auth\Adapters\Database',
'config' =&gt; [
@@ -141,7 +141,7 @@ VALUES
'database' =&gt; 'filegator',
],
],</code></pre>
<p>Don't forget to enter correct mysql username, password, and database.</p>
<p>Don't forget to enter correct database details.</p>
</section>
</div>

View File

@@ -102,7 +102,7 @@
<section class="col-sm-offset-3 col-lg-offset-2 col-sm-9 col-lg-10">
<h2 id="basic">Basic</h2>
<p>Edit <code>configuration.php</code> file to change basic things like logo, title, language and upload restrictions.</p>
<p>You can edit <code>configuration.php</code> 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 throw an error. Please use provided default <code>configuration_sample.php</code> to verify this.</p>
<h2 id="additional-html">Additional HTML</h2>
<p>You can add additional html to the head and body like this:</p>

View File

@@ -110,7 +110,7 @@
`sess_time` int(10) unsigned NOT NULL,
PRIMARY KEY (`sess_id`)
) CHARSET=utf8 COLLATE=utf8_bin;</code></pre>
<p>Then, open <code>configuration.php</code> and update Auth handler under section <code>services</code> to something like this:</p>
<p>Then, open <code>configuration.php</code> and update Session handler to:</p>
<pre><code> 'Filegator\Services\Session\SessionStorageInterface' =&gt; [
'handler' =&gt; '\Filegator\Services\Session\Adapters\SessionStorage',
'config' =&gt; [
@@ -127,9 +127,9 @@
],
],
</code></pre>
<p>Don't forget to enter correct mysql username, password, and database.</p>
<p>Don't forget to enter correct database details.</p>
<h2 id="tweaking-session-options">Tweaking session options</h2>
<p>The underying Symfony's session <a href="https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php">component</a> accepts array of options.
<p>The underying <a href="https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php">session component</a> accepts array of options.
For example you can pass <code>cookie_lifetime</code> parameter to extend default session lifetime:</p>
<pre><code> 'Filegator\Services\Session\SessionStorageInterface' =&gt; [
'handler' =&gt; '\Filegator\Services\Session\Adapters\SessionStorage',

View File

@@ -103,9 +103,10 @@
<section class="col-sm-offset-3 col-lg-offset-2 col-sm-9 col-lg-10">
<h2 id="adapters">Adapters</h2>
<p>Different storage adapters are provided through the awesome <a href="https://github.com/thephpleague/flysystem">Flysystem</a> library.</p>
<p>You can use local filesystem (default), FTP, S3, Dropbox and many others. Please check Flysystem docs for the exact setup required for each adapter.</p>
<p>You can use local filesystem (default), FTP, S3, Dropbox and many others.</p>
<p>Please check the Flysystem <a href="https://github.com/thephpleague/flysystem">docs</a> for the exact setup required for each adapter.</p>
<h2 id="default-local-disk-adapter">Default Local Disk Adapter</h2>
<p>With default adapter you just need to configure where your <code>repository</code> folder is. This folder will serve as root for everything else.</p>
<p>With default adapter you just need to configure where your <code>repository</code> folder is. This folder will serve as a root for everything else.</p>
<pre><code> 'Filegator\Services\Storage\Filesystem' =&gt; [
'handler' =&gt; '\Filegator\Services\Storage\Filesystem',
'config' =&gt; [

View File

@@ -103,8 +103,8 @@
<section class="col-sm-offset-3 col-lg-offset-2 col-sm-9 col-lg-10">
<h2 id="demo">Demo</h2>
<p><a href="https://demo.filegator.io"><a href="https://demo.filegator.io">https://demo.filegator.io</a></a></p>
<p>This is read-only demo with guest account enabled.
You can also log in with john/john to see John's private files.</p>
<p>This is read-only demo with guest account enabled.</p>
<p>You can also log in with john/john to see John's private files.</p>
</section>
</div>

View File

@@ -104,10 +104,10 @@
<h2 id="filegator">FileGator</h2>
<p><a href="https://filegator.io">FileGator</a> is a free, open-source PHP script for managing files and folders.</p>
<p>You can manage files inside your local repository folder (on your server's hard drive) or connect to other storage adaptes (see below).</p>
<p>FileGator has multi-user support so you can have admins and other users managing files with different access permissions, roles and home folders.</p>
<p>FileGator has multi-user support so you can have admins and other users managing the files with different access permissions, roles and home folders.</p>
<p>All basic file operations are supported: copy, move, rename, create, delete, zip, unzip, download, upload.</p>
<p>If allowed, users can download multiple files or folders at once.</p>
<p>File upload supports drag&amp;drop, progress bar, pause and resume. Upload is chunked so you should be able to upload large files regardless of your server configuration.</p>
<p>File upload supports drag&amp;drop, progress bar, pause and resume. Upload is chunked so you should be able to upload large files regardless of your server's configuration.</p>
<h2 id="features-amp-goals">Features &amp; Goals</h2>
<ul>
<li>Multiple storage adapters (Local, FTP, S3, Dropbox and many others via <a href="https://github.com/thephpleague/flysystem">Flysystem</a>)</li>