enabled ru, pt, es, although not much content yet.
[dl_bitmask_net.git] / README.md
1 Bitmask downloads
2 -----------------------------------------
3
4 This is the Bitmask download website (https://dl.bitmask.net)
5
6 It is entirely static, but relies on a bunch of apache tricks for things like language negotiation and pretty directory indexes.
7
8 The static content files in ./public/ are rendered from the content in ./pages/ using the command `amber rebuild`.
9
10 To install amber:
11
12     gem install amber
13
14 See https://github.com/elijh/amber for more information.
15
16 Requirements
17 -----------------------------------------
18
19 The following apache mods are required:
20
21     sudo a2enmod include rewrite autoindex mime negotiation
22
23 The following apache directives are required, on the document root:
24
25     Options +Indexes
26     IndexOptions +FancyIndexing +Charset=UTF-8
27     IndexOptions +SuppressRules +SuppressDescription +NameWidth=*
28     IndexOptions +FoldersFirst +VersionSort
29     IndexOptions +SuppressHTMLPreamble +HTMLTable
30     HeaderName /assets/header.html
31     ReadmeName /assets/footer.html
32
33     AddIcon /assets/icons/blank.png ^^BLANKICON^^
34     AddIcon /assets/icons/folder.png ^^DIRECTORY^^
35     AddIcon /assets/icons/folder-home.png ..
36     AddIcon /assets/icons/audio.png .aif .iff .m3u .m4a .mid .mp3 .mpa .ra .wav .wma .f4a .f4b .oga .ogg
37     AddIcon /assets/icons/bin.png .bin
38     AddIcon /assets/icons/c.png .c
39     AddIcon /assets/icons/calc.png .xlsx .xlsm .xltx .xltm .xlam .xlr .xls .csv
40     AddIcon /assets/icons/css.png .css
41     AddIcon /assets/icons/deb.png .deb
42     AddIcon /assets/icons/doc.png .doc .docx .docm .dot .dotx .dotm .log .msg .odt .pages .rtf .tex .wpd .wps
43     AddIcon /assets/icons/draw.png .svg
44     AddIcon /assets/icons/eps.png .ai .eps
45     AddIcon /assets/icons/gif.png .gif
46     AddIcon /assets/icons/html.png .html .xhtml .shtml .htm
47     AddIcon /assets/icons/ico.png .ico
48     AddIcon /assets/icons/java.png .jar
49     AddIcon /assets/icons/jpg.png .jpg .jpeg
50     AddIcon /assets/icons/js.png .js .json
51     AddIcon /assets/icons/markdown.png .md
52     AddIcon /assets/icons/package.png .pkg .dmg
53     AddIcon /assets/icons/pdf.png .pdf
54     AddIcon /assets/icons/php.png .php .phtml
55     AddIcon /assets/icons/png.png .png
56     AddIcon /assets/icons/ps.png .ps
57     AddIcon /assets/icons/psd.png .psd
58     AddIcon /assets/icons/rar.png .rar
59     AddIcon /assets/icons/rb.png .rb
60     AddIcon /assets/icons/rpm.png .rpm
61     AddIcon /assets/icons/rss.png .rss
62     AddIcon /assets/icons/sql.png .sql
63     AddIcon /assets/icons/tiff.png .tiff
64     AddIcon /assets/icons/text.png .txt .nfo
65     AddIcon /assets/icons/video.png .asf .asx .avi .flv .mkv .mov .mp4 .mpg .rm .srt .swf .vob .wmv .m4v .f4v .f4p .ogv
66     AddIcon /assets/icons/xml.png .xml
67     AddIcon /assets/icons/zip.png .zip
68     DefaultIcon /assets/icons/default.png
69
70 Credits
71 -----------------------------------------
72
73 Dir listing style from Apaxy - https://github.com/AdamWhitcroft/Apaxy
74 License: in the public domain.
75
76 Icons are from "Faenza Icons" -- http://tiheum.deviantart.com/art/Faenza-Icons-173323228
77 License: GNU General Public License.
78
79 Stylesheet is from Bootstrap -- http://getbootstrap.com
80 License: Apache, version 2 -- https://www.apache.org/licenses/LICENSE-2.0.html
81   customized with:
82     common css: typography, code, grid, tables, buttons
83     components: breadcrumbs, badges, jumbotron, thumbnails, alerts, list groups, wells
84     utilities: basic, responsive
85
86 The fonts are Font Awesome -- http://fortawesome.github.io
87 License: SIL OFL 1.1 -- http://scripts.sil.org/OFL