deploy: c9cb5afa91

docs/configuration/basic.md

@@ -0,0 +1,76 @@
+---
+currentMenu: basic
+---
+
+## Basic
+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.
+
+
+You can edit `configuration.php` file to change the basic things like logo image, title, language and upload restrictions.
+
+
+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 `configuration_sample.php` to put everything back to normal.
+
+```
+    '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/'],
+    ],
+```
+
+## Additional HTML
+You can add additional html to the head and body like this:
+```
+        '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>',
+            ],
+        ],
+```
+
+## Frontend tweaks
+To change default color scheme and other options, edit `frontend/App.vue` When you're done, recompile with `npm run build` like described [here](/development.html)
+
+```
+// 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;
+```
+