mirror of
https://github.com/MrUnknownDE/unknownbin.git
synced 2026-04-17 21:33:46 +02:00
52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
# unknownBIN
|
|
unknownBIN is a secure and modern open-source Pastebin software written in node.js.
|
|
It is a fork of the original Hastebin and Hastebin Plus, modernized for security and performance.
|
|
|
|
## Features
|
|
* Paste code, logs and ... almost everything!
|
|
* Syntax-Highlighting
|
|
* Add static documents
|
|
* Duplicate & edit pastes
|
|
* Raw paste-view
|
|
* Secure, unpredictable paste IDs
|
|
* Modernized backend with security enhancements
|
|
|
|
## Installation
|
|
1. Install Git and node.js (a recent LTS version is recommended).
|
|
2. Clone this repository: `git clone https://github.com/MrUnknownDE/unknownbin.git unknownbin`
|
|
3. Change into the directory: `cd unknownbin`
|
|
4. Install dependencies: `npm install`
|
|
5. Build static assets: `npm run build`
|
|
6. Open `config.json` and change the settings (if you want to).
|
|
7. Start the application: `npm start`
|
|
|
|
## Update
|
|
1. Pull changes from the repository: `git pull`
|
|
2. Install new dependencies: `npm install`
|
|
3. Re-build static assets: `npm run build`
|
|
4. Restart the application.
|
|
|
|
## Settings
|
|
| Key | Description | Default value |
|
|
| ---------------------- | ----------------------------------------------- | ------------- |
|
|
| `host` | The host the server runs on | `0.0.0.0` |
|
|
| `port` | The port the server runs on | `8080` |
|
|
| `dataPath` | The directory where all pastes are stored | `./data` |
|
|
| `keyLength` | The length of the pastes' key | `10` |
|
|
| `maxLength` | Maximum chars in a paste | `500000` |
|
|
| `createKey` | Needs to be in front of paste to allow creation | `""` |
|
|
| `documents` | Static documents to serve | See below |
|
|
|
|
### Default Config
|
|
```json
|
|
{
|
|
"host": "0.0.0.0",
|
|
"port": 8080,
|
|
"dataPath": "./data",
|
|
"keyLength": 10,
|
|
"maxLength": 500000,
|
|
"createKey": "",
|
|
"documents": {
|
|
"about": "./README.md"
|
|
}
|
|
} |