Added LICENSE and README.md

This commit is contained in:
Said Achmiz 2022-02-02 04:29:53 -05:00
parent 6414f3f53c
commit 3ac5d5e38a
2 changed files with 28 additions and 0 deletions

7
LICENSE Normal file
View File

@ -0,0 +1,7 @@
Copyright 2022 Said Achmiz.
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.

21
README.md Normal file
View File

@ -0,0 +1,21 @@
OborPaste, a simple pastebin you can run on any server with Apache and PHP.
## Installation
Rename `_htaccess` to `.htaccess`. Replace the placeholder URLs and file paths in `.htaccess`, `textfiles.html`, and `textfiles.php` to appropriate values; replace the placeholder API key in `textfiles.php` with an arbitrary key of your choice (this can be any string you like, but dont share it with anyone). Put everything in `/textfiles/` (where `/` is your web root).
## Usage
Post textfiles by sending a POST request to `/textfiles/textfiles.php`, with two parameters: `f` (whose value should be the contents of the textfile) and `p` (whose value should be the API key youve defined in `textfiles.php`.
The response to the POST request will contain the URL of the newly-created paste. You can append `/raw` to that URL to view the raw text of the paste.
## Notes
You can, of course, change the path from `/textfiles/` to anything else, modifying the scripts, config files, etc. in the obvious manner.
Font Awesome is required for the action icons on paste pages. A free version may be found at https://fontawesome.com/ (they even provide a CDN, so you dont have to host it yourself).
Probably OborPaste can be adapted to work with a webserver other than Apache (as long as it has an equivalent of `mod_php`), but youd have to replicate the configuration defined in the `.htaccess` file in whatever form of config file thats appropriate to your webserver of choice.
Copyright 2022 Said Achmiz.