Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kiritsu/uploadr

Upload server for files, pastes, shortened urls, etc. made with ASP.NET Core 5
https://github.com/kiritsu/uploadr

asp-netcore azure-pipelines csharp database hacktoberfest netcore postgresql sharex-upload

Last synced: 2 days ago
JSON representation

Upload server for files, pastes, shortened urls, etc. made with ASP.NET Core 5

Awesome Lists containing this project

README

        

# UploadR

[![Build Status](https://dev.azure.com/allanmercou/uploadr/_apis/build/status/Kiritsu.uploadr?branchName=master)](https://dev.azure.com/allanmercou/uploadr/_build/latest?definitionId=7&branchName=master)

UploadR is a simple server-side uploading service made with ASP.NET Core 5.

# Requirements

In order to use UploadR, you need the following components:
- ASP.NET Core 5
- PostgreSQL Server

# Configuration

Use the pre-made file `uploadr.json` to create your configuration. This file must be in the same directory as the executable. You can also set an environment variable `UPLOADR_PATH`.

## Database setup

Follow these instructions if you need help to setup your PostgreSQL database for UploadR.

- Connect to your PostgreSQL database as a super-user.
- Create a user. In our case, its name will be `uploadr`. Replace `your_password` by a strong password.
```sql
CREATE USER uploadr PASSWORD 'your_password';
```
- Create a database. In our case, its name will be `uploadr`. Don't forget to change the owner name if you used something else than `uploadr`.
```sql
CREATE DATABASE uploadr WITH OWNER 'uploadr';
```

## Database configuration

- `Hostname` is the hostname of your PostgreSQL server. Default is `localhost` if it's ran locally.
- `Port` is the port of your PostgreSQL server. Default is `5432`.
- `Database` is the name of the target PostgreSQL database that you created in `Database Setup`.
- `Username` is the name of the user that you created in `Database Setup`.
- `Password` is the password of the user that you created in `Database Setup`.

# Using UploadR

You need `Visual Studio 2019` or the `.NET 5 SDK` in order to build UploadR.
If you are building from a terminal, use the following command:
```
dotnet publish -c Release -r [RUNTIME]
```
You can replace [RUNTIME] by either `win-x64`, `linux-x64`, etc. depending on the target operating system. See Microsoft documentation for .NET Core runtime if you have troubles.