librecat/README.md

41 lines
1.4 KiB
Markdown

# Librecat
Librecat is a ask.fm/curiouscat clone but FLOSS. It tries to be as minimal as possible while being a comfortable alternative to those mentioned while not using JS (at least for default theme).
It's PHP based, only depending on the SQLite3 PHP extension.
## Features
- Fancy URL handling (opt-in)
- Social media response posting (Mastodon API and Twitter support)
- Custom theme support
- No JS used by default
## Installing
1. Choose the web server you want, install PHP and PHP's SQLite3 extension.
2. Copy ```include/settings.php.default``` to ```include/settings.php``` and customize the options you want
## URL Rewrites
URL Rewrites are optional, but recommended for a more polished look. They can be activated in ```include/settings.php``` with proper http server rewrite rules configurations.
For now there's only Nginx implementation of those. Feel free to contribute since they're a little messy (but they work as expected)
### NGINX
``` nginx
rewrite ^/$ /index.php last;
rewrite ^/(.*).php$ /$1.php last;
rewrite ^/(.*).css$ /$1.css last;
rewrite ^/user/(.*)?(.*) /user.php?q=$1&$2 last;
rewrite ^/user/(.*) /user.php?q=$1 last;
rewrite ^/config/(.*)$ /config.php?q=$1 last;
rewrite ^/(.*)\.(.*)$ /$1.$2 last;
rewrite ^/(.*)$ /$1.php last;
```
## Contributing
Pull requests and issues are welcome