zer0bin/README.md

48 lines
1.3 KiB
Markdown
Raw Normal View History

2022-02-28 21:10:02 +00:00
<div align="center">
2022-03-01 00:03:11 +00:00
<h1>zer0bin</h1>
2022-03-01 00:31:42 +00:00
<a href="https://stepbro.voring.me">zer0b.in</a>, just a place to paste
2022-02-28 21:10:02 +00:00
<br>
2022-02-28 23:42:09 +00:00
<img src="./frontend/zero.png" />
<br>
2022-02-28 21:10:02 +00:00
<br>
</div>
# API
[**GET**] `/p/:id` - Get a paste
2022-02-28 21:10:52 +00:00
2022-02-28 21:10:02 +00:00
[**POST**] `/p/n` - Post a new paste
# License
MIT
2022-03-01 00:17:29 +00:00
2022-03-01 02:00:07 +00:00
# Public instances
2022-03-01 02:07:35 +00:00
Submit your public instance [here](https://github.com/Domterion/zer0bin/issues/new?assignees=&labels=&template=03_public_instance.md&title=%F0%9F%9A%80+)!
2022-03-01 02:00:07 +00:00
2022-03-01 02:16:46 +00:00
| Website | Country | Ratelimits | Expiration | Version |
2022-03-01 02:17:11 +00:00
|-|-|-|-|-|
2022-03-01 02:16:46 +00:00
| zer0b.in (not up yet) | ? | N/A | 7 days | non-existant |
| [stepbro.voring.me](https://stepbro.voring.me) | 🇺🇸 | N/A | ∞ days | v0.0.1 |
2022-03-01 02:00:07 +00:00
2022-03-01 00:17:29 +00:00
# Instructions
### Requirements
- Rust >= 1.58.0
- Postgresql >= 12.0
- Nginx >= 1.18.0
2022-03-01 02:17:59 +00:00
- \*nix OS
2022-03-01 00:17:29 +00:00
2022-03-01 02:18:11 +00:00
### Steps
2022-03-01 00:17:29 +00:00
1. `git clone https://github.com/Domterion/zer0bin && cd zer0bin`
2. `cp config.example.json config.json` and edit as appropriate
3. `cp example.nginx /etc/nginx/sites-avaliable/yoursite.tld`, edit as appropriate, `sudo cp /etc/nginx/sites-avaliable/yoursite.tld /etc/nginx/sites-enabled/yoursite.tld && systemctl nginx restart`
4. `psql -d postgres`
2022-03-01 00:23:20 +00:00
5. `CREATE DATABSE zer0bin;` and `\c zer0bin`
2022-03-01 00:17:29 +00:00
6. Paste contents of `schema.sql`
7. `\q`
8. `cd backend`
9. `cargo build --release`
2022-03-01 00:30:24 +00:00
10. `./target/release/backend`, preferably in a `tmux` session or with `& disown`