SHare and shoRTen Daemon, simple file, paste & url sharing daemon

Notice: This is still in early development and is not intended for production use right now.

• User-programmable configuration:
  • Custom Slug, best effort
  • Slug length, minimum of sever-configured Slug
  • Expiry date of the Record & Record detention duration
  • Maximum download count
  • Input Checksum verification
• File upload (POST /file with streamed input)
• Redirect creation (POST /redirect)
• Paste creation (POST /paste)
• Getting record (GET /<slug>)
• Retention curve depending on the weight, with expiration in return headers
• Delete token in return headers, allowing deletion of a record
• Add the full path when returning the URL
• Add a homepage to the project to /
• Clean orphaned files at startup, if relevant and safe
• Reliability
  • Fix race conditions on files
  • Use redis transactions if relevant

Currently the project requires you to host a Redis server locally for it to function properly.

You will need docker and docker-compose installed.

Once this is the case, you can run shrtd with:

$ docker-compose up -d

You can also modify the options of SHRTD with environment variable configuration by editing the environment section of the shrtd service.

• Léon ROUX [email protected]
• Olivier Moreau [email protected]

MIT License

Copyright (c) 2021 Léon ROUX

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.