From ba216339648003ecdb65e5c6d8c5b150f4873c10 Mon Sep 17 00:00:00 2001 From: Milos Stojanovic Date: Fri, 12 Jul 2019 09:40:11 +0200 Subject: [PATCH] Website generation with Couscous --- accounts.html | 5 + configuration/auth.html | 5 + configuration/basic.html | 5 + configuration/logging.html | 5 + configuration/router.html | 5 + configuration/security.html | 5 + configuration/session.html | 5 + configuration/storage.html | 5 + configuration/tmpfs.html | 182 ++++++++++++++++++++++++++++++++++++ demo.html | 5 + development.html | 6 ++ index.html | 5 + install.html | 5 + translations/default.html | 5 + 14 files changed, 248 insertions(+) create mode 100644 configuration/tmpfs.html diff --git a/accounts.html b/accounts.html index b3ff247..4daa68c 100644 --- a/accounts.html +++ b/accounts.html @@ -106,6 +106,11 @@ Router + +
  • + + Tmpfs +

    • diff --git a/configuration/auth.html b/configuration/auth.html index 7191b72..0edcdd8 100644 --- a/configuration/auth.html +++ b/configuration/auth.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/configuration/basic.html b/configuration/basic.html index d8270b4..62c5f54 100644 --- a/configuration/basic.html +++ b/configuration/basic.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/configuration/logging.html b/configuration/logging.html index a952b46..df6b6ee 100644 --- a/configuration/logging.html +++ b/configuration/logging.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/configuration/router.html b/configuration/router.html index 6af3164..366aff5 100644 --- a/configuration/router.html +++ b/configuration/router.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/configuration/security.html b/configuration/security.html index 7d465bc..e91cacf 100644 --- a/configuration/security.html +++ b/configuration/security.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/configuration/session.html b/configuration/session.html index a3c20e2..ca7cb0f 100644 --- a/configuration/session.html +++ b/configuration/session.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/configuration/storage.html b/configuration/storage.html index 6b67c9b..39e70f6 100644 --- a/configuration/storage.html +++ b/configuration/storage.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/configuration/tmpfs.html b/configuration/tmpfs.html new file mode 100644 index 0000000..36e3b61 --- /dev/null +++ b/configuration/tmpfs.html @@ -0,0 +1,182 @@ + + + + + + + FileGator - Documentation + + + + + + + + +

    + + + FileGator + + + + + + Fork me on GitHub + + + +
    + +
    +
    + + + + + +
    +

    Temporary file system service

    +

    This service is responsible for managing temporary files. TMP files are created:

    +
      +
    • When uploading files, chunks are stored in the TMP folder before merging and moving to the final storage destination
      • +
    • When creating and extracting archives (zip files)
      • +
    • When downloading multiple files, they are copied into TMP folder before zipping
      • +
    +

    Tmp files are usually removed immediately after the use. For expired files, configurable garbage collection is used:

    +
            'Filegator\Services\Tmpfs\TmpfsInterface' => [
+            'handler' => '\Filegator\Services\Tmpfs\Adapters\Tmpfs',
+            'config' => [
+                'path' => __DIR__.'/private/tmp/',
+                'gc_probability_perc' => 10,
+                'gc_older_than' => 60 * 60 * 24 * 2, // 2 days
+            ],
+        ],
    +

    Note: if you want to use this script as a stateless app or in any kind of multi-node environment, you must must mount a single shared TMP folder for all the instances. You can solve this problem with Amazon Elastic File System or similar approach.

    +
    + +
    +
    + + + + + + + + + + + + + + diff --git a/demo.html b/demo.html index 16ea491..b941ba9 100644 --- a/demo.html +++ b/demo.html @@ -106,6 +106,11 @@ Router + +
  • + + Tmpfs +

    • diff --git a/development.html b/development.html index 90858a8..158191f 100644 --- a/development.html +++ b/development.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • @@ -134,6 +139,7 @@ sudo chmod -R 777 repository/ composer install npm install npm run build +

    We also have a sample docker image here

    Compiles and hot-reloads

    The following command will launch backend and frontend on ports 8081 and 8080:

    npm run serve
    diff --git a/index.html b/index.html index 1e14675..18d08c8 100644 --- a/index.html +++ b/index.html @@ -106,6 +106,11 @@ Router + +
  • + + Tmpfs +

    • diff --git a/install.html b/install.html index f73a53c..ee68a99 100644 --- a/install.html +++ b/install.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +

    • diff --git a/translations/default.html b/translations/default.html index 1d7ec9e..9bdd2aa 100644 --- a/translations/default.html +++ b/translations/default.html @@ -106,6 +106,11 @@ Router + +

  • + + Tmpfs +