- Go 46%
- JavaScript 28.3%
- HTML 14%
- CSS 7.9%
- Dockerfile 3.8%
| static | ||
| .dockerignore | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| about.md | ||
| docker-compose.yaml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
| package-lock.json | ||
| package.json | ||
| Procfile | ||
| README.md | ||
| renovate.json | ||
| server.js | ||
Haste
Haste is an open-source pastebin software written in Go, which is easily installable in any network. It is backed by redis in this version. A publicly available version can be found at hastebin.com
Major design objectives:
- Be really pretty
- Be really simple
- Be easy to set up and use
Haste works really well with a little utility called haste-client, allowing you to do things like:
cat something | haste
which will output a URL to share containing the contents of cat something's
STDOUT. Check the README there for more details and usages.
Tested Browsers
- Firefox 8
- Chrome 17
- Safari 5.3
Installation
- Download the package, and expand it
- Explore the settings inside of config.js, but the defaults should be good
go build./haste-server(you may specify an optional<config-path>as well)
Settings
host- the host the server runs on (default localhost)port- the port the server runs on (default 7777)keyLength- the length of the keys to user (default 10)maxLength- maximum length of a paste (default 400000)staticMaxAge- max age for static assets (86400)recompressStaticAssets- whether or not to compile static js assets (true)documents- static documents to serve (ex: http://hastebin.com/about.com) in addition to static assets. These will never expire.storage- storage options (see below)logging- logging preferenceskeyGenerator- key generator options (see below)rateLimits- settings for rate limiting (see below)
Rate Limiting
When present, the rateLimits option enables built-in rate limiting courtesy
of connect-ratelimit. Any of the options supported by that library can be
used and set in config.js.
See the README for connect-ratelimit for more information!
Key Generation
Phonetic
Attempts to generate phonetic keys, similar to pwgen
{
"type": "phonetic"
}
Random
Generates a random key
{
"type": "random",
"keyspace": "abcdef"
}
The optional keySpace argument is a string of acceptable characters for the key.
Storage
Redis
Once you've done that, your config section should look like:
{
"type": "redis",
"host": "localhost",
"port": 6379,
"db": 2
}
You can also set an expire option to the number of seconds to expire keys in.
This is off by default, but will constantly kick back expirations on each view
or post.
All of which are optional except type with very logical default values.
If your Redis server is configured for password authentification, use the password field. REDISTOGO_URL is also supported for URL-based Redis deployments.
Only the Redis backend is implemented in this Go version.
Docker
Build image
docker build --tag haste-server .
Run container
For this example we will run haste-server, and connect it to a redis server
docker run --name haste-server-container --env STORAGE_TYPE=redis --env STORAGE_HOST=redis-server --env STORAGE_PORT=6379 haste-server
Use docker-compose example
There is an example docker-compose.yml which runs haste-server together with redis
docker-compose up
Configuration
The docker image is configured using environmental variables as you can see in the example above.
Here is a list of all the environment variables
Storage
| Name | Default value | Description |
|---|---|---|
| STORAGE_TYPE | redis | Storage type. Only redis is supported by this Go backend. |
| STORAGE_HOST | 127.0.0.1 | Redis host. |
| STORAGE_PORT | 6379 | Redis port. |
| STORAGE_EXPIRE_SECONDS | 2592000 | Number of seconds to expire keys in. |
| STORAGE_DB | 2 | Redis database index. |
| STORAGE_PASSWORD | Redis password. |
Basics
| Name | Default value | Description |
|---|---|---|
| HOST | 0.0.0.0 | The hostname which the server answers on |
| PORT | 7777 | The port on which the server is running |
| KEY_LENGTH | 10 | the length of the keys to user |
| MAX_LENGTH | 400000 | maximum length of a paste |
| STATIC_MAX_AGE | 86400 | max age for static assets |
| RECOMPRESS_STATIC_ASSETS | true | whether or not to compile static js assets |
| KEYGENERATOR_TYPE | phonetic | Type of key generator. Acceptable values: "phonetic", or "random" |
| KEYGENERATOR_KEYSPACE | keySpace argument is a string of acceptable characters | |
| DOCUMENTS | about=./about.md | Comma separated list of static documents to serve. ex: \n about=./about.md,home=./home.md |
Rate limits
| Name | Default value | Description |
|---|---|---|
| RATELIMITS_NORMAL_TOTAL_REQUESTS | 500 | By default anyone uncategorized will be subject to 500 requests in the defined timespan. |
| RATELIMITS_NORMAL_EVERY_MILLISECONDS | 60000 | The timespan to allow the total requests for uncategorized users |
| RATELIMITS_WHITELIST_TOTAL_REQUESTS | By default client names in the whitelist will not have their requests limited. | |
| RATELIMITS_WHITELIST_EVERY_SECONDS | By default client names in the whitelist will not have their requests limited. | |
| RATELIMITS_WHITELIST | example1.whitelist,example2.whitelist | Comma separated list of the clients which are in the whitelist pool |
| RATELIMITS_BLACKLIST_TOTAL_REQUESTS | 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. |
Author
John Crepezzi john.crepezzi@gmail.com
License
(The MIT License)
Copyright © 2011-2012 John Crepezzi
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 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 SOFTWARE
Other components:
- jQuery: MIT/GPL license
- highlight.js: Copyright © 2006, Ivan Sagalaev
- highlightjs-coffeescript: WTFPL - Copyright © 2011, Dmytrii Nagirniak