t/fluffle
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
trisua 2025-08-18 21:44:30 -04:00
parent 187508b8f3
commit e647e54916
1 changed files with 2 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -2,27 +2,11 @@
Fluffle is a familiar Markdown pastebin-y site :)
Since Tetratto is used as a backend, you'll obviously need to create an app at <https://tetratto.com/developer>. Once you've created the app, scroll down to "Secret key" and roll the key. Copy the key since you'll need it for later.
## Usage
Once you've cloned the repository, cd into the `app` directory and run `cargo run -r`.
Before you run the server, however, you should create a `.env` file to store your API key (that you rolled earlier). In the `.env` file, put the following:
```ini
API_KEY=<your key>
```
So if your key was "ABCD123", you would have:
```ini
API_KEY=ABCD123
```
Once this file is in place, you can safely run the server. You can also optionally add a `PORT` variable in there to change the port number. If you don't change the port, you can find the server at `http://localhost:9119`.
It's important to note that you're fairly limited on app storage without the Tetratto developer pass. You can manage your billing settings at <https://tetratto.com/settings#/account/billing>.
After you start the server the first time, a `fluffle.toml`file will be created in the current directory. You'll need to edit that file to configure your PostgreSQL connection, instance name/theme color, etc.
## Customization
@ -38,7 +22,7 @@ Once you've built the binary, it'll be located at (from the root `fluffle/` dire
All templates are compiled with [nanoneo](https://trisua.com/t/nanoneo), so it's recommended that you familiarize yourself with that syntax.
You can set a master password to be able to freely edit all entries by using the `MASTER_PASS` environment variable.
You can set a master password to be able to freely edit all entries by using the `master_pass` configuration key. A password is automatically generated on first start as well. Please note that this value is stored in plain text.
## Attribution