summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 289ead211b6e986af6469a4a91fa889dde30a76c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# FileBin

A pastebin software running on [https://paste.xinu.at](https://paste.xinu.at).
In addition to uploading text and code it also supports binary files.

Additional documentation can be found in [`./doc`](doc/).

## Installation/Development

Git is used for tracking changes and updating installations. The repository is
located at [https://git.server-speed.net/users/flo/filebin/](https://git.server-speed.net/users/flo/filebin/).
Clone the repository and follow the instructions in `./INSTALL`. Do not
install using tarballs as this is not supported.

`dev` is the development branch and should not be used in production. All
stable changes go to `master` and will be tagged regularly following [semver
guidelines](http://semver.org/).

There is currently no bug tracking software.

### Mailing List

Currently there is only [one mailing
list](https://lists.server-speed.net/listinfo/filebin-general) for everything
(general discussion, patches, announcements, ...). If need be more lists will be
created at a later date.

### Patches

Please submit patches (preferably git send-email) to the [filebin-general
mailing list](https://lists.server-speed.net/listinfo/filebin-general). You do
not need to register to be allowed to post.


## Dependencies

*  PHP >=5.5 with the following modules
    * gd for thumbnail generation
    * exif for thumbnail generation
    * phar for tarball creation
    * mysql, mysqli, pgsql, pdo_mysql (any of those) for database access

*  perl with the following CPAN Modules
    * Text::Markdown for markdown rendering

*  [pygmentize](http://pygments.org/) for code highlighting
*  [ansi2html](http://pypi.python.org/pypi/ansi2html) for shell output rendering (ANSI color codes)
*  [imagemagick](http://www.imagemagick.org/) for additional thumbnail generation
*  [node.js](https://nodejs.org/) for javascript minification