Loading .dockerignore 0 → 100644 +6 −0 Original line number Diff line number Diff line npm-debug.log node_modules *.swp *.swo data *.DS_Store Dockerfile 0 → 100644 +63 −0 Original line number Diff line number Diff line FROM node:14.8.0-stretch RUN mkdir -p /usr/src/app && \ chown node:node /usr/src/app USER node:node WORKDIR /usr/src/app COPY --chown=node:node . . RUN npm install && \ npm install redis@0.8.1 && \ npm install pg@4.1.1 && \ npm install memcached@2.2.2 && \ npm install aws-sdk@2.738.0 && \ npm install rethinkdbdash@2.3.31 ENV STORAGE_TYPE=memcached \ STORAGE_HOST=127.0.0.1 \ STORAGE_PORT=11211\ STORAGE_EXPIRE_SECONDS=2592000\ STORAGE_DB=2 \ STORAGE_AWS_BUCKET= \ STORAGE_AWS_REGION= \ STORAGE_USENAMER= \ STORAGE_PASSWORD= \ STORAGE_FILEPATH= ENV LOGGING_LEVEL=verbose \ LOGGING_TYPE=Console \ LOGGING_COLORIZE=true ENV HOST=0.0.0.0\ PORT=7777\ KEY_LENGTH=10\ MAX_LENGTH=400000\ STATIC_MAX_AGE=86400\ RECOMPRESS_STATIC_ASSETS=true ENV KEYGENERATOR_TYPE=phonetic \ KEYGENERATOR_KEYSPACE= ENV RATELIMITS_NORMAL_TOTAL_REQUESTS=500\ RATELIMITS_NORMAL_EVERY_MILLISECONDS=60000 \ RATELIMITS_WHITELIST_TOTAL_REQUESTS= \ RATELIMITS_WHITELIST_EVERY_MILLISECONDS= \ # comma separated list for the whitelisted \ RATELIMITS_WHITELIST=example1.whitelist,example2.whitelist \ \ RATELIMITS_BLACKLIST_TOTAL_REQUESTS= \ RATELIMITS_BLACKLIST_EVERY_MILLISECONDS= \ # comma separated list for the blacklisted \ RATELIMITS_BLACKLIST=example1.blacklist,example2.blacklist ENV DOCUMENTS=about=./about.md EXPOSE ${PORT} STOPSIGNAL SIGINT ENTRYPOINT [ "bash", "docker-entrypoint.sh" ] HEALTHCHECK --interval=30s --timeout=30s --start-period=5s \ --retries=3 CMD [ "curl" , "-f" "localhost:${PORT}", "||", "exit", "1"] CMD ["npm", "start"] README.md +120 −0 Original line number Diff line number Diff line Loading @@ -198,6 +198,126 @@ Also, you must create an `uploads` table, which will store all the data for uplo You can optionally add the `user` and `password` properties to use a user system. ### Amazon S3 To use [Amazon S3](https://aws.amazon.com/s3/) as a storage system, you must install the `aws-sdk` package via npm: `npm install aws-sdk` Once you've done that, your config section should look like this: ```json { "type": "amazon-s3", "bucket": "your-bucket-name", "region": "us-east-1" } ``` Authentication is handled automatically by the client. Check [Amazon's documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) for more information. You will need to grant your role these permissions to your bucket: ```json { "Version": "2012-10-17", "Statement": [ { "Action": [ "s3:GetObject", "s3:PutObject" ], "Effect": "Allow", "Resource": "arn:aws:s3:::your-bucket-name-goes-here/*" } ] } ``` ## Docker ### Build image ```bash docker build --tag haste-server . ``` ### Run container For this example we will run haste-server, and connect it to a redis server ```bash 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 memcached ```bash 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 | memcached | Type of storage . Accepted values: "memcached","redis","postgres","rethinkdb", "amazon-s3", and "file" | | STORAGE_HOST | 127.0.0.1 | Storage host. Applicable for types: memcached, redis, postgres, and rethinkdb | | STORAGE_PORT | 11211 | Port on the storage host. Applicable for types: memcached, redis, postgres, and rethinkdb | | STORAGE_EXPIRE_SECONDS | 2592000 | Number of seconds to expire keys in. Applicable for types. Redis, postgres, memcached. `expire` option to the | | STORAGE_DB | 2 | The name of the database. Applicable for redis, postgres, and rethinkdb | | STORAGE_PASSWORD | | Password for database. Applicable for redis, postges, rethinkdb . | | STORAGE_USERNAME | | Database username. Applicable for postgres, and rethinkdb | | STORAGE_AWS_BUCKET | | Applicable for amazon-s3. This is the name of the S3 bucket | | STORAGE_AWS_REGION | | Applicable for amazon-s3. The region in which the bucket is located | | STORAGE_FILEPATH | | Path to file to save data to. Applicable for type file | ### Logging | Name | Default value | Description | | :---------------: | :-----------: | :---------: | | LOGGING_LEVEL | verbose | | | LOGGING_TYPE= | Console | | LOGGING_COLORIZE= | true | ### 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> Loading config.js +1 −4 Original line number Diff line number Diff line Loading @@ -33,10 +33,7 @@ }, "storage": { "type": "memcached", "host": "127.0.0.1", "port": 11211, "expire": 2592000 "type": "file" }, "documents": { Loading docker-compose.yaml 0 → 100644 +19 −0 Original line number Diff line number Diff line version: '3.0' services: haste-server: build: . networks: - db-network environment: - STORAGE_TYPE=memcached - STORAGE_HOST=memcached - STORAGE_PORT=11211 ports: - 7777:7777 memcached: image: memcached:latest networks: - db-network networks: db-network: Loading
.dockerignore 0 → 100644 +6 −0 Original line number Diff line number Diff line npm-debug.log node_modules *.swp *.swo data *.DS_Store
Dockerfile 0 → 100644 +63 −0 Original line number Diff line number Diff line FROM node:14.8.0-stretch RUN mkdir -p /usr/src/app && \ chown node:node /usr/src/app USER node:node WORKDIR /usr/src/app COPY --chown=node:node . . RUN npm install && \ npm install redis@0.8.1 && \ npm install pg@4.1.1 && \ npm install memcached@2.2.2 && \ npm install aws-sdk@2.738.0 && \ npm install rethinkdbdash@2.3.31 ENV STORAGE_TYPE=memcached \ STORAGE_HOST=127.0.0.1 \ STORAGE_PORT=11211\ STORAGE_EXPIRE_SECONDS=2592000\ STORAGE_DB=2 \ STORAGE_AWS_BUCKET= \ STORAGE_AWS_REGION= \ STORAGE_USENAMER= \ STORAGE_PASSWORD= \ STORAGE_FILEPATH= ENV LOGGING_LEVEL=verbose \ LOGGING_TYPE=Console \ LOGGING_COLORIZE=true ENV HOST=0.0.0.0\ PORT=7777\ KEY_LENGTH=10\ MAX_LENGTH=400000\ STATIC_MAX_AGE=86400\ RECOMPRESS_STATIC_ASSETS=true ENV KEYGENERATOR_TYPE=phonetic \ KEYGENERATOR_KEYSPACE= ENV RATELIMITS_NORMAL_TOTAL_REQUESTS=500\ RATELIMITS_NORMAL_EVERY_MILLISECONDS=60000 \ RATELIMITS_WHITELIST_TOTAL_REQUESTS= \ RATELIMITS_WHITELIST_EVERY_MILLISECONDS= \ # comma separated list for the whitelisted \ RATELIMITS_WHITELIST=example1.whitelist,example2.whitelist \ \ RATELIMITS_BLACKLIST_TOTAL_REQUESTS= \ RATELIMITS_BLACKLIST_EVERY_MILLISECONDS= \ # comma separated list for the blacklisted \ RATELIMITS_BLACKLIST=example1.blacklist,example2.blacklist ENV DOCUMENTS=about=./about.md EXPOSE ${PORT} STOPSIGNAL SIGINT ENTRYPOINT [ "bash", "docker-entrypoint.sh" ] HEALTHCHECK --interval=30s --timeout=30s --start-period=5s \ --retries=3 CMD [ "curl" , "-f" "localhost:${PORT}", "||", "exit", "1"] CMD ["npm", "start"]
README.md +120 −0 Original line number Diff line number Diff line Loading @@ -198,6 +198,126 @@ Also, you must create an `uploads` table, which will store all the data for uplo You can optionally add the `user` and `password` properties to use a user system. ### Amazon S3 To use [Amazon S3](https://aws.amazon.com/s3/) as a storage system, you must install the `aws-sdk` package via npm: `npm install aws-sdk` Once you've done that, your config section should look like this: ```json { "type": "amazon-s3", "bucket": "your-bucket-name", "region": "us-east-1" } ``` Authentication is handled automatically by the client. Check [Amazon's documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) for more information. You will need to grant your role these permissions to your bucket: ```json { "Version": "2012-10-17", "Statement": [ { "Action": [ "s3:GetObject", "s3:PutObject" ], "Effect": "Allow", "Resource": "arn:aws:s3:::your-bucket-name-goes-here/*" } ] } ``` ## Docker ### Build image ```bash docker build --tag haste-server . ``` ### Run container For this example we will run haste-server, and connect it to a redis server ```bash 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 memcached ```bash 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 | memcached | Type of storage . Accepted values: "memcached","redis","postgres","rethinkdb", "amazon-s3", and "file" | | STORAGE_HOST | 127.0.0.1 | Storage host. Applicable for types: memcached, redis, postgres, and rethinkdb | | STORAGE_PORT | 11211 | Port on the storage host. Applicable for types: memcached, redis, postgres, and rethinkdb | | STORAGE_EXPIRE_SECONDS | 2592000 | Number of seconds to expire keys in. Applicable for types. Redis, postgres, memcached. `expire` option to the | | STORAGE_DB | 2 | The name of the database. Applicable for redis, postgres, and rethinkdb | | STORAGE_PASSWORD | | Password for database. Applicable for redis, postges, rethinkdb . | | STORAGE_USERNAME | | Database username. Applicable for postgres, and rethinkdb | | STORAGE_AWS_BUCKET | | Applicable for amazon-s3. This is the name of the S3 bucket | | STORAGE_AWS_REGION | | Applicable for amazon-s3. The region in which the bucket is located | | STORAGE_FILEPATH | | Path to file to save data to. Applicable for type file | ### Logging | Name | Default value | Description | | :---------------: | :-----------: | :---------: | | LOGGING_LEVEL | verbose | | | LOGGING_TYPE= | Console | | LOGGING_COLORIZE= | true | ### 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> Loading
config.js +1 −4 Original line number Diff line number Diff line Loading @@ -33,10 +33,7 @@ }, "storage": { "type": "memcached", "host": "127.0.0.1", "port": 11211, "expire": 2592000 "type": "file" }, "documents": { Loading
docker-compose.yaml 0 → 100644 +19 −0 Original line number Diff line number Diff line version: '3.0' services: haste-server: build: . networks: - db-network environment: - STORAGE_TYPE=memcached - STORAGE_HOST=memcached - STORAGE_PORT=11211 ports: - 7777:7777 memcached: image: memcached:latest networks: - db-network networks: db-network:
