diff --git a/Home.md b/Home.md index e71e5fb..59c307b 100644 --- a/Home.md +++ b/Home.md @@ -1,93 +1,26 @@ # PrivateBin -PrivateBin is a minimalist, opensource online pastebin where the server has zero -knowledge of pasted data. +Welcome to the PrivateBin wiki! Depending on who you are and what you want to do, we have a few guides for you. -Data is encrypted/decrypted in the browser using 256 bit AES. +## I want to use PrivateBin -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. +Have a look at [the list of public PrivateBin](PrivateBin-Directory). -## What PrivateBin provides +## I am a server administrator wanting to setup PrivateBin -+ 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 - of the pastes content. If requested or enforced, you can delete any paste from - your system. +Have a look at our [installation guide](Installation) and [configuration](Configuration) guides. If you upgrade from the old 0.19 alpha version please [read the upgrade guide](Upgrading-from-ZeroBin-0.19-Alpha). +If you use Red Hat [here is another guide](Installation-on-Red-Hat-with-SELinux) for installing ZeroBin with SELinux. -+ Pastebin-like system to store text documents, code samples, etc. +If you finished setting up your PrivateBin instance, you can add it to the [directory](https://github.com/PrivateBin/PrivateBin/wiki/PrivateBin-Directory). +You can also adjust the [design of your instance](Templates) -+ Encryption of data sent to server, even if it does not provide HTTPS. +## I want to contribute to your project -+ Possibility to set a password which is required to read the paste. It further - protects a paste and prevents people stumbling upon your paste's link - from being able to read it without the password. +At first, awesome you take the time to make PrivateBin better! :tada: :+1: -## What it doesn't provide +Have a look at our [Contributing guide](Development). +However also by translating you can help very much. In this case have a look at the [translation guide](Translation). -- As a user you have to trust the server administrator, your internet provider - and any country the traffic passes not to inject any malicious javascript code. - Ideally, the PrivateBin installation used would provide HTTPS, secured by - [HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) and - [HPKP](https://en.wikipedia.org/wiki/HTTP_Public_Key_Pinning) using a - certificate either validated by a trusted third party (check the certificate - when first using a new PrivateBin instance) or self-signed by the server - operator, validated using a - [DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) - protected - [DANE](https://en.wikipedia.org/wiki/DNS-based_Authentication_of_Named_Entities) - record. +## I want to use PrivateBin in my application -- The "key" used to encrypt the paste is part of the URL. If you publicly post - the URL of a paste that is not password-protected, everybody can read it. - Use a password if you want your paste to be private. - -- A server admin might be forced to hand over access logs to the authorities. - PrivateBin 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/PrivateBin/PrivateBin/wiki/Configuration): - -* Password protection - -* Discussions - -* Expiration times, including a "forever" and "burn after reading" option - -* Markdown format support for HTML formatted pastes - -* Syntax highlighting for source code using prettify.js, including 4 prettify - themes - -* File upload support, images get displayed (disabled by default, possibility - to adjust size limit) - -* Templates: By default there is a bootstrap CSS and a "classic ZeroBin" theme - and it is easy to adapt these to your own websites layout or create your own. - -* Translation system and automatic browser language detection (if enabled in - browser) - -* Language selection (disabled by default, as it uses a session cookie) - -## Further resources - -* [Installation guide](https://github.com/PrivateBin/PrivateBin/wiki/Installation) - -* [Upgrading from 0.19 Alpha](https://github.com/PrivateBin/PrivateBin/wiki/Upgrading-from-ZeroBin-0.19-Alpha) - -* [Configuration guide](https://github.com/PrivateBin/PrivateBin/wiki/Configuration) - -* [Templates](https://github.com/PrivateBin/PrivateBin/wiki/Templates) - -* [Translation guide](https://github.com/PrivateBin/PrivateBin/wiki/Translation) - -* [Developer guide](https://github.com/PrivateBin/PrivateBin/wiki/Development) - -Run into any issues? Have ideas for further developments? Please -[report](https://github.com/PrivateBin/PrivateBin/issues) them! +PrivateBin offers you an [API](API), so feel free to integrate it into your application. If you have a working prototype please let us know, so \ No newline at end of file