Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,30 @@ | ||
# PasteMyst | ||
|
||
A lightweight and simple website for pasting text, mainly code snippets. | ||
|
||
## Building | ||
|
||
Dependencies: | ||
|
||
* mariadb-server | ||
|
||
You'll need to have an `appsettings.json` file in the root of the project which will contain: | ||
|
||
```json | ||
{ | ||
"dbConnection": "host=localhost;user=CodeMyst;db=PasteMyst", | ||
"hashidsSalt": "pastemyst" | ||
} | ||
``` | ||
|
||
The `dbConnection` property is the connection string for connecting to the MariaDB. You can also specify the password for the database like so: | ||
|
||
```json | ||
"host=localhost;user=CodeMyst;db=PasteMyst;pwd=password" | ||
``` | ||
|
||
The `hashidsSalt` property is the salt used by [hashids](https://hashids.org/) to generate IDs for PasteMysts. | ||
|
||
In [index.dt](/views/index.dt) you'll see that a Google reCAPTCHA key is required. You'll have to generate your own at [reCAPTCHA docs](https://developers.google.com/recaptcha/intro). | ||
|
||
To build / run the project simply run `dub build` / `dub run`. |