Updated Home (markdown)

El RIDO 2015-08-23 18:12:25 +02:00
parent ef9047b210
commit 35c3429c41

52
Home.md

@ -1,7 +1,55 @@
# ZeroBin
ZeroBin is a minimalist, opensource online pastebin where the server has zero knowledge of pasted data. Data is encrypted/decrypted in the browser using 256 bits AES.
ZeroBin is a minimalist, opensource online pastebin where the server has zero knowledge of pasted data.
Data is encrypted/decrypted in the browser using 256 bits AES.
This fork of ZeroBin refactored the source code to allow easier and cleaner extensions. It is still fully compatible to the original ZeroBin 0.19 data storage scheme. Therefore such installations can be upgraded to this fork without loosing any data.
Visit the [installation guide](Installation) or help us [developing](Development) the tool. You are welcome to [report us](https://github.com/elrido/ZeroBin/issues) any of your ideas or issues you encountered.
## What ZeroBin provides
- As a server administrator you don't have to worry if your users post content
that is considered illegal in your country. You have no knowledge of any
pastes content. If requested or enforced, you can delete any paste from your
system.
- Pastebin like system to store text documents, code samples, etc.
- Encryption of data sent to server, even if it does not provide HTTPS.
## What it doesn't provide
- As a user you have to trust the server administrator, your internet provider
and any country the traffic passes not to inject any malicious code.
- The "password" to encrypt the paste is part of the URL. If you publicly post
a paste URL, everybody can read it.
- A server admin might be forced to hand over access logs to the authorities.
ZeroBin encrypts your text and the discussion contents, but who accessed it
first might still be disclosed via such access logs.
## Options
Some features are optional and can be enabled or disabled in the [configuration
file](https://github.com/elrido/ZeroBin/wiki/Configuration):
- Discussions
- Expiration times, including a "forever" and "burn after reading" option
- Syntax highlighting using prettify.js, including 4 prettify themes
- Templates: By default there is a "classic" and a bootstrap based theme, but it
is easy to adapt these to your own websites layout.
## Further resources
- [Installation guide](Installation)
- [Configuration guide](Configuration)
- [Developer guide](Development)
Run into any issues? Have ideas for further developments? Please
[report](../issues) them!