mirror of
https://github.com/seejohnrun/haste-server
synced 2025-08-21 10:53:09 -07:00
Merge pull request #1 from MelvinSnijders/readme-update
📝 Updated README.md
This commit is contained in:
commit
cfc0380ee8
2 changed files with 28 additions and 68 deletions
61
README.md
61
README.md
|
@ -1,19 +1,9 @@
|
||||||
# Important announcement:
|
# Hastebin
|
||||||
|
|
||||||
## [Soon a new version of Hastebin will be launched!](https://github.com/toptal/haste-server/issues/429)
|
Hastebin is an open-source pastebin software written in node.js, which is easily
|
||||||
|
|
||||||
[Check here what you need to know.](https://github.com/toptal/haste-server/issues/429)
|
|
||||||
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.
|
|
||||||
|
|
||||||
# Haste
|
|
||||||
|
|
||||||
Haste is an open-source pastebin software written in node.js, which is easily
|
|
||||||
installable in any network. It can be backed by either redis or filesystem,
|
installable in any network. It can be backed by either redis or filesystem,
|
||||||
and has a very easy adapter interface for other stores. A publicly available
|
and has a very easy adapter interface for other stores. A publicly available
|
||||||
version can be found at [hastebin.com](http://hastebin.com)
|
version can be found at [hastebin.dev](https://hastebin.dev)
|
||||||
|
|
||||||
Major design objectives:
|
Major design objectives:
|
||||||
|
|
||||||
|
@ -21,20 +11,17 @@ Major design objectives:
|
||||||
* Be really simple
|
* Be really simple
|
||||||
* Be easy to set up and use
|
* Be easy to set up and use
|
||||||
|
|
||||||
Haste works really well with a little utility called
|
## History
|
||||||
[haste-client](https://github.com/seejohnrun/haste-client), allowing you
|
|
||||||
to do things like:
|
|
||||||
|
|
||||||
`cat something | haste`
|
The original Hastebin website (.com version) was acquired by Toptal in 2021. To the frustration of many people, Toptal has created its own version of Hastebin, which violates all of the above major design objectives.
|
||||||
|
That is why I strive to offer the original version of hastebin to everyone.
|
||||||
which will output a URL to share containing the contents of `cat something`'s
|
You can always visit this version at the domain: [hastebin.dev](https://hastebin.dev)
|
||||||
STDOUT. Check the README there for more details and usages.
|
|
||||||
|
|
||||||
## Tested Browsers
|
## Tested Browsers
|
||||||
|
|
||||||
* Firefox 8
|
* Firefox 116
|
||||||
* Chrome 17
|
* Chrome 116
|
||||||
* Safari 5.3
|
* Safari 16.6
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -51,7 +38,7 @@ STDOUT. Check the README there for more details and usages.
|
||||||
* `maxLength` - maximum length of a paste (default 400000)
|
* `maxLength` - maximum length of a paste (default 400000)
|
||||||
* `staticMaxAge` - max age for static assets (86400)
|
* `staticMaxAge` - max age for static assets (86400)
|
||||||
* `recompressStaticAssets` - whether or not to compile static js assets (true)
|
* `recompressStaticAssets` - whether or not to compile static js assets (true)
|
||||||
* `documents` - static documents to serve (ex: http://hastebin.com/about.com)
|
* `documents` - static documents to serve (ex: http://hastebin.dev/about.com)
|
||||||
in addition to static assets. These will never expire.
|
in addition to static assets. These will never expire.
|
||||||
* `storage` - storage options (see below)
|
* `storage` - storage options (see below)
|
||||||
* `logging` - logging preferences
|
* `logging` - logging preferences
|
||||||
|
@ -109,7 +96,7 @@ something like:
|
||||||
|
|
||||||
where `path` represents where you want the files stored.
|
where `path` represents where you want the files stored.
|
||||||
|
|
||||||
File storage currently does not support paste expiration, you can follow [#191](https://github.com/seejohnrun/haste-server/issues/191) for status updates.
|
File storage currently does not support paste expiration.
|
||||||
|
|
||||||
### Redis
|
### Redis
|
||||||
|
|
||||||
|
@ -364,33 +351,29 @@ Here is a list of all the environment variables
|
||||||
| RATELIMITS_BLACKLIST_EVERY_SECONDS | | By default client names in the blacklist will be subject to 0 requests per hours |
|
| RATELIMITS_BLACKLIST_EVERY_SECONDS | | By default client names in the blacklist will be subject to 0 requests per hours |
|
||||||
| RATELIMITS_BLACKLIST | example1.blacklist,example2.blacklist | Comma separated list of the clients which are in the blacklistpool. |
|
| RATELIMITS_BLACKLIST | example1.blacklist,example2.blacklist | Comma separated list of the clients which are in the blacklistpool. |
|
||||||
|
|
||||||
## Author
|
|
||||||
|
|
||||||
John Crepezzi <john.crepezzi@gmail.com>
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
(The MIT License)
|
MIT License
|
||||||
|
|
||||||
Copyright © 2011-2012 John Crepezzi
|
Copyright (c) 2023 Melvin Snijders
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
this software and associated documentation files (the ‘Software’), to deal in
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
the Software without restriction, including without limitation the rights to
|
in the Software without restriction, including without limitation the rights
|
||||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
of the Software, and to permit persons to whom the Software is furnished to do
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
so, subject to the following conditions:
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The above copyright notice and this permission notice shall be included in all
|
||||||
copies or substantial portions of the Software.
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
SOFTWARE
|
SOFTWARE.
|
||||||
|
|
||||||
### Other components:
|
### Other components:
|
||||||
|
|
||||||
|
|
33
about.md
33
about.md
|
@ -13,29 +13,6 @@ URL to someone and they'll see what you see.
|
||||||
|
|
||||||
To make a new entry, click "New" (or type 'control + n')
|
To make a new entry, click "New" (or type 'control + n')
|
||||||
|
|
||||||
## From the Console
|
|
||||||
|
|
||||||
Most of the time I want to show you some text, it's coming from my current
|
|
||||||
console session. We should make it really easy to take code from the console
|
|
||||||
and send it to people.
|
|
||||||
|
|
||||||
`cat something | haste` # https://hastebin.com/1238193
|
|
||||||
|
|
||||||
You can even take this a step further, and cut out the last step of copying the
|
|
||||||
URL with:
|
|
||||||
|
|
||||||
* osx: `cat something | haste | pbcopy`
|
|
||||||
* linux: `cat something | haste | xsel -b`
|
|
||||||
* windows: check out [WinHaste](https://github.com/ajryan/WinHaste)
|
|
||||||
|
|
||||||
After running that, the STDOUT output of `cat something` will show up at a URL
|
|
||||||
which has been conveniently copied to your clipboard.
|
|
||||||
|
|
||||||
That's all there is to that, and you can install it with `gem install haste`
|
|
||||||
right now.
|
|
||||||
* osx: you will need to have an up to date version of Xcode
|
|
||||||
* linux: you will need to have rubygems and ruby-devel installed
|
|
||||||
|
|
||||||
## Duration
|
## Duration
|
||||||
|
|
||||||
Pastes will stay for 30 days from their last view. They may be removed earlier
|
Pastes will stay for 30 days from their last view. They may be removed earlier
|
||||||
|
@ -43,7 +20,7 @@ and without notice.
|
||||||
|
|
||||||
## Privacy
|
## Privacy
|
||||||
|
|
||||||
While the contents of hastebin.com are not directly crawled by any search robot
|
While the contents of hastebin.dev are not directly crawled by any search robot
|
||||||
that obeys "robots.txt", there should be no great expectation of privacy. Post
|
that obeys "robots.txt", there should be no great expectation of privacy. Post
|
||||||
things at your own risk. Not responsible for any loss of data or removed
|
things at your own risk. Not responsible for any loss of data or removed
|
||||||
pastes.
|
pastes.
|
||||||
|
@ -52,10 +29,10 @@ pastes.
|
||||||
|
|
||||||
Haste can easily be installed behind your network, and it's all open source!
|
Haste can easily be installed behind your network, and it's all open source!
|
||||||
|
|
||||||
* [haste-client](https://github.com/seejohnrun/haste-client)
|
* [haste-server](https://github.com/MelvinSnijders/haste-server)
|
||||||
* [haste-server](https://github.com/seejohnrun/haste-server)
|
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
|
||||||
Code by John Crepezzi <john.crepezzi@gmail.com>
|
Modifications by Melvin Snijders <info@hastebin.dev>
|
||||||
Key Design by Brian Dawson <bridawson@gmail.com>
|
Original author John Crepezzi <john.crepezzi@gmail.com>
|
||||||
|
Original Design by Brian Dawson <bridawson@gmail.com>
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue