Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CorentinTh/snut
Another pastebin with a clean and minimalist ui.
https://github.com/CorentinTh/snut
clean emit minimalist pastebin self-hosted send share text transmit
Last synced: 3 months ago
JSON representation
Another pastebin with a clean and minimalist ui.
- Host: GitHub
- URL: https://github.com/CorentinTh/snut
- Owner: CorentinTh
- License: mit
- Created: 2021-12-22T22:27:59.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T10:05:23.000Z (3 months ago)
- Last Synced: 2024-08-06T22:30:06.859Z (3 months ago)
- Topics: clean, emit, minimalist, pastebin, self-hosted, send, share, text, transmit
- Language: TypeScript
- Homepage: https://snut.thomasset.co
- Size: 341 KB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - CorentinTh/snut - Another pastebin with a clean and minimalist ui. (self-hosted)
README
# Snut
Another pastebin with a clean and minimalist ui. Made for selfhosting.
Use it online : [snut.thomasset.co](https://snut.thomasset.co/)
## Host your instance
### Installation
```shell
docker run -d --restart unless-stopped -v $(pwd)/db:/app/db -e DATABASE_PATH=/app/db/db.sqlite -p 3000:3000 --name snut corentinth/snut:nightly
```
### Configuration
| ENV variable | Default value | Format | Description |
| ------------------ | ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------- |
| NODE_ENV | development | production, development, test | The application environment. |
| PORT | 3000 | port | The port to bind. |
| MS_BEFORE_OUTDATED | 3600000 | Number | The duration in ms before an entry is outdated. |
| CHECK_OUTDATED_MS | 10000 | Number | The interval in ms to check for outdated. |
| DB_TYPE | sqlite | sqlite, mysql, postgres, cockroachdb, mariadb | The database type |
| DB_PATH | ./db.sqlite | String | Sqlite database path. |
| THROTTLE_TTL | 1800000 | Number | Timeframe for which requests are checked/remembered. |
| THROTTLE_LIMIT | 100 | Number | Max number of connections during windowMs milliseconds before sending a 429 response. |
## Contribute
**Pull requests are welcome !** Feel free to contribute.
To contribute to this project, first clone this repo
```bash
git clone [email protected]:CorentinTh/snut.git
```
### Installation
```bash
pnpm i
```
### Running the app
```bash
# development
pnpm dev
```
### Test
```bash
# unit tests
pnpm test
```
## Credits
Coded with ❤️ by [Corentin Thomasset](https://github.com/CorentinTh).
Name found with ❤️ by [Aimie Tremoureux](https://twitter.com/dwenna_art).
## License
This project is under the [MIT license](LICENSE).