Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/truewinter/nodeupload-s3

S3 version of NodeUpload (which allows you to run your own file hosting service)
https://github.com/truewinter/nodeupload-s3

file-hosting file-sharing image-sharing sharex sharex-server

Last synced: 7 months ago
JSON representation

S3 version of NodeUpload (which allows you to run your own file hosting service)

Awesome Lists containing this project

README 

          
# NodeUpload S3



NodeUpload S3 is a version of [NodeUpload](https://github.com/TrueWinter/nodeupload) that allows you to use S3 to store files. It uses randomly generated file names and ensures that a file name is unique before uploading files.



The list of files in S3 are only retrieved when NodeUpload starts up. Therefore, it is important that the directory you use for uploads (`s3.remotePath` in the config) is only used by NodeUpload. Do not manually add or remove files from this directory without restarting NodeUpload.



## Installing



```sh

npm install

nano config.json # Configure NodeUpload (you can use something other than nano for this)

node createUser.js # This is the script for creating users

node app.js

```



For production use, it is recommended that you use a process manager such as PM2.



## Configuration



Rename `config.json.example` to `config.json` and then modify the settings as required:



| Option | Description | Required |

|---     |---          |---       |

| filenameLength | How long the generated file name will be | Y |

| port | The port that NodeUpload S3 runs on | Y |

| indexForm | If the online upload form should be shown | Y |

| indexFormDisabledMessage | The message that is shown if the online upload form is disabled | N\* |

| extBlacklist | Files with these extensions will not be allowed | Y |

| ratelimitAfter | After this many requests in the `ratelimitTime`, rate limit requests | Y |

| ratelimitTime | See `ratelimitAfter` description | Y |

| logs.enable | If logs are enabled | Y |

| logs.dir | The directory that logs will be saved in | N\*\* |

| logs.file | The file that logs will be saved in | N\*\* |

| logs.format | Log format | Y |

| s3.bucket | S3 bucket | Y |

| s3.s3_endpoint | S3 endpoint | Y |

| s3.s3_accessKeyId | S3 access key | Y |

| s3.s3_secretAccessKey | S3 secret key | Y |

| s3.s3_region | S3 region | Y |

| s3.remotePath | If you want the files to be uploaded to a different folder on S3 | N |

| s3.redirectToAfterUpload | If you want users to be redirected to the URL of their file, insert that URL here | N |



\* Required if `indexForm` is set to `true`



\*\* These are required if `logs.enable` is set to `true`



## Creating a New User

To create a new user, run the following command and answer the questions.



```sh

node createUser.js

```



## Usage



If the server is not already started, run `node app.js`.

Once the server has started, open a web browser to `YOUR_IP:PORT` (where `PORT` is the port specified in the config file (`config.json`)).



If everything worked, it should show an upload form (unless disabled in the config file). Just add your token where it says `Token`, choose a file to upload, then click the button. It should upload. If not, check the console for errors. You may need to open an issue here.



ShareX is also supported. Download `nodeupload.sxcu` to your computer and double click it. This should import the uploader config into ShareX. You will then need to go to the custom uploader settings (Destinations -> Custom uploader settings) and modify the uploader as needed.



![Usage GIF](docs/assets/img/usage.gif)



Some file extensions are blacklisted by default. These can be changed in the config file.

- .exe

- .html

- .htm

- .bat

- .cmd

- .sh



## FAQs



  > What is this?



  NodeUpload is a Node.js server application that lets you run your own private file upload service. It uses randomly generated tokens for upload authentication.



  > How are uploads done?



  When a user uploads a file, it will be stored in a directory in your operating system's temp directory. Then there will be a connection to the database to check that the token is valid. If it is valid, the file gets uploaded to S3 using a randomly generated file name.



  > How are tokens generated?



  Tokens generated are not based on any information given when running `createUser.js`. The information there is only used to be stored in the database for your convenience. The token is generated by the [`uuid` module](https://www.npmjs.com/package/uuid) (`uuid/v4`) to generate a completely random token.



  > Does it check for information already existing in the database when running `createUser.js`?



  Yes, this feature has been added.



  > Is there any way to change the port that it runs on?



  To change the port that NodeUpload runs on, edit the config file (`config.json`).



  > Is there any way to change the length of the generated file names of uploads?



  To change the length of the auto generated file names of uploads, edit the config file (`config.json`).



  > Is there any way to change the responses (console output, web responses, etc.)?



  Yes, there is. Edit the `strings.json` file. The placeholders (`{{placeholder}}`) in these cannot be used in all strings. The code will have to be changed if you want to add these into strings that do not have support for it. Note that not all strings can be changed. Please see [the docs](https://nodeupload.truewinter.dev) for more details.



  > Can I contribute to the development of NodeUpload by opening pull requests?



  Yes, you can open a pull request but please use the format [here](https://github.com/TrueWinter/nodeupload-s3/blob/master/PULL_REQUESTS.md)



  > I found a bug, how do I report it?



  To report a bug, open an issue using the format [here](https://github.com/TrueWinter/nodeupload-s3/blob/master/BUGS.md)



  > Can I request a feature?



  Yes, I am open to feedback and feature requests. Just open an issue using the format [here](https://github.com/TrueWinter/nodeupload-s3/blob/master/FEATURE_REQUESTS.md)



## LICENSE

MIT License



Copyright (c) 2020 TrueWinter



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.