iUpdate README.md - fiche - A pastebin adjusted for gopher use Err vernunftzentrum.de 70 hgit clone git://vernunftzentrum.de/fiche.git URL:git://vernunftzentrum.de/fiche.git vernunftzentrum.de 70 1Log /ckeen/repos/fiche/log.gph vernunftzentrum.de 70 1Files /ckeen/repos/fiche/files.gph vernunftzentrum.de 70 1Refs /ckeen/repos/fiche/refs.gph vernunftzentrum.de 70 1LICENSE /ckeen/repos/fiche/file/LICENSE.gph vernunftzentrum.de 70 i--- Err vernunftzentrum.de 70 1commit 6b2569b406a2d7aa8c5da2c30ddc716b2026fe82 /ckeen/repos/fiche/commit/6b2569b406a2d7aa8c5da2c30ddc716b2026fe82.gph vernunftzentrum.de 70 1parent 924341e9733fcf18bd870214e92c2e36208e7d91 /ckeen/repos/fiche/commit/924341e9733fcf18bd870214e92c2e36208e7d91.gph vernunftzentrum.de 70 hAuthor: solusipse URL:mailto:solus1ps3@gmail.com vernunftzentrum.de 70 iDate: Sat, 14 Sep 2013 01:00:23 +0200 Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 iUpdate README.md Err vernunftzentrum.de 70 iDiffstat: Err vernunftzentrum.de 70 i README.md | 157 ++++++++++++++++++++++++++----- Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i1 file changed, 132 insertions(+), 25 deletions(-) Err vernunftzentrum.de 70 i--- Err vernunftzentrum.de 70 1diff --git a/README.md b/README.md /ckeen/repos/fiche/file/README.md.gph vernunftzentrum.de 70 i@@ -32,65 +32,172 @@ ls -la | nc localhost 9999 Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i-cat file.txt | nc someserverrunningfiche.net 1234 Err vernunftzentrum.de 70 i+cat file.txt | nc solusipse.net 9999 Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i echo just testing! | nc code.solusipse.net 9999 Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-If you already haven't set up your server on localhost, try third line! My server is providing terminal Err vernunftzentrum.de 70 i-pastebin server powered by fiche - ```code.solusipse.net``` on port ```9999```. Err vernunftzentrum.de 70 i+If you haven't already set up your server on localhost, try second or third command. My personal server is Err vernunftzentrum.de 70 i+providing fiche-based service all the time on this address `solusipse.net` and this port `9999`. Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i - To upload text you need to have netcat installed (to check if netcat is installed, simply type ```nc``` in terminal). Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ## Server-side usage ## Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i-usage: fiche [-bdpqs]. Err vernunftzentrum.de 70 i- [-d host_domain.com] [-p port] [-s slug_size] Err vernunftzentrum.de 70 i- [-o output_directory] [-b buffer_size] [-q queue_size] Err vernunftzentrum.de 70 i+usage: fiche [-pbsdolBuw]. Err vernunftzentrum.de 70 i+ [-d domain] [-p port] [-s slug size] Err vernunftzentrum.de 70 i+ [-o output directory] [-B buffer size] [-u user name] Err vernunftzentrum.de 70 i+ [-l log file] [-b banlist] [-w whitelist] Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-These are command line arguments. You don't have to provide any, but doing that is recommended. Without them, program Err vernunftzentrum.de 70 i+These are command line arguments. You don't have to provide any, but providing basic is recommended. Without them, program Err vernunftzentrum.de 70 i will use these default settings: Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-```C Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i domain = "http://localhost/"; Err vernunftzentrum.de 70 i basedir= "~/code/"; Err vernunftzentrum.de 70 i port = 9999; Err vernunftzentrum.de 70 i slug_size = 4; Err vernunftzentrum.de 70 i buffer_size = 8192; Err vernunftzentrum.de 70 i-queue_size = 100; Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-Examples: Err vernunftzentrum.de 70 i+### Arguments ### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Most important is providing **basedir** and **domain**. Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### Basedir #### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Basedir should be **absolute** path to directory where you would like to store text files. Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -b /absolute/path/to/directory/ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -b /home/www/code/ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### Domain #### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Domain should be provided in such format ```domain.com```. Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i fiche -d domain.com Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i-fiche -s 6 -p 6666 Err vernunftzentrum.de 70 i+fiche -d subdomain.domain.com Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-### Basic arguments ### Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-Most important is providing **basedir** and **domain**. Err vernunftzentrum.de 70 i+#### Slug size #### Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-Basedir should be **absolute** path to directory where you would like to store text files. Err vernunftzentrum.de 70 i+This will force fiche to create random slugs with given length, example: Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-Domain should be provided in such format ```domain.com```. Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -s 6 Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+http://domain.com/abcdef/ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### User name #### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+If you use fiche as service (see details below) you may want to save files as other user, to do that use `-u` option, Err vernunftzentrum.de 70 i+there's example: Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -u http Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### Buffersize #### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+This parameter defines max file size uploaded by user, by default it is set to `32768`. Err vernunftzentrum.de 70 i+Use `-B` parameter to change it: Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -B 2048 Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### Log file ### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Path to file where all logs will be stored: Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -l /home/www/fiche-log.txt Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### Ban list ### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Path to file where you provided all banned IP adresses: Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -b /home/www/fiche-bans.txt Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### White list #### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+If whitelist mode is enabled, only addresses from list will be able to upload files. There's example: Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -w /home/www/fiche-whitelist.txt Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-Slug size: ```domain.com/SLUG_OF_CHOSEN_LENGTH/```. Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### Whitelist and banlist syntax #### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+There is no specific syntax, there files may contain not only addresses. Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+#### Examples #### Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Logging connections with banlist: Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -d domain.com -l /home/www/log.txt -b /home/www/bans.txt Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Only for personal use with whitelist Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -d domain.com -w /home/www/whitelist.txt Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+----------------- Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+Custom output directory, bigger slug size, reduced buffer, custom port: Err vernunftzentrum.de 70 i+ Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i+fiche -d domain.com -o /media/disk/fiche/ -s 8 -B 2048 -p 6666 Err vernunftzentrum.de 70 i+``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-### Parameters for advanced users ### Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-- Buffer size Err vernunftzentrum.de 70 i-- Queue size Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ## Running as service ## Err vernunftzentrum.de 70 i-e Err vernunftzentrum.de 70 i You can run fiche as service, there is simple systemd example: Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i@@ -98,13 +205,13 @@ You can run fiche as service, there is simple systemd example: Err vernunftzentrum.de 70 i Description=FICHE-SERVER Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i [Service] Err vernunftzentrum.de 70 i-ExecStart=/usr/local/bin/fiche -d code.solusipse.net -o /home/www/code/ Err vernunftzentrum.de 70 i+ExecStart=/usr/local/bin/fiche -d code.solusipse.net -o /home/www/code/ -l /home/www/log.txt Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i [Install] Err vernunftzentrum.de 70 i WantedBy=multi-user.target Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i-In service mode you have to set output directory with ```-d``` parameter, there's example: Err vernunftzentrum.de 70 i+In service mode you have to set output directory with `-o` parameter, there's example: Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 i fiche -o /home/www/code/ Err vernunftzentrum.de 70 i@@ -113,7 +220,7 @@ fiche -o /home/www/code/ Err vernunftzentrum.de 70 i ## Webserver ## Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i To make files available for users, you need to host them somehow. Http server is easiest option. Just set root Err vernunftzentrum.de 70 i-directory to ```BASEDIR```. **Remember that you have to distribute these files as plain text for safety measures!** Err vernunftzentrum.de 70 i+directory to ```BASEDIR```. Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i There is sample configuration for nginx: Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i@@ -121,11 +228,11 @@ There is sample configuration for nginx: Err vernunftzentrum.de 70 i server { Err vernunftzentrum.de 70 i listen 80; Err vernunftzentrum.de 70 i server_name mysite.com www.mysite.com; Err vernunftzentrum.de 70 i- add_header Content-Type text/plain; Err vernunftzentrum.de 70 i+ charset utf-8; Err vernunftzentrum.de 70 i Err vernunftzentrum.de 70 i location / { Err vernunftzentrum.de 70 i root /home/www/code/; Err vernunftzentrum.de 70 i- index index.html; Err vernunftzentrum.de 70 i+ index index.txt index.html; Err vernunftzentrum.de 70 i } Err vernunftzentrum.de 70 i } Err vernunftzentrum.de 70 i ``` Err vernunftzentrum.de 70 .