diff options
| -rw-r--r-- | README.md | 19 |
1 files changed, 10 insertions, 9 deletions
@@ -6,30 +6,31 @@ A simple PHP app that stores Twitter-like status updates in a sqlite database. I There is a timeline view of your own posts, as well as a simple 'compose post' page behind a login form. Right now, only a unique ID, the post content and creation timestamp, edit time and delete status are saved for each entry, so this is only suitable for one user. (Multiple users would each have to install in their own directories.) -The entire design is inside a single theme file [microblog.css](microblog.css) and can be modified easily. The site HTML is pretty straightforward and should be easy to style. +The entire design is inside a single theme file [microblog.css](css/microblog.css) and can be modified easily. The site HTML is pretty straightforward and should be easy to style. -ATOM and JSON feeds are provided and rendered as static files when posting. +ATOM and JSON feeds are provided and rerendered as static files when posting. -If the PHP version on the server supports it, an XML-RPC interface is provided to enable posting from external apps, such as [Marsedit](https://redsweater.com/marsedit/). Please set an `app_token` in the config as secret to use with your username. If you don't set one, you have to use your login password to authenticate. +If the PHP version on the server supports it, an XML-RPC interface is provided to enable posting from external apps, such as [Marsedit](https://redsweater.com/marsedit/). Please set an `app_token` in [config.php](config-dist.php#L28) as secret to use with your username. If you don't set one, you have to use your login password to authenticate. You can use the metaWeblog API, that is discovered automatically, or add a Micro.Blog account and point it to your site. That will use the superior API that includes pagination support. As a bonus, you can schedule posts this way, if you set the creation date in the future ;) -The app requires at least PHP 5.5 and was tested on 8.1. It needs mbstring, curl and sqlite modules. +The app requires at least PHP 5.6 and was tested on 8.1. It needs mbstring, curl and sqlite modules. For crossposting to twitter, the app uses code from [J7mbo/twitter-api-php](https://github.com/J7mbo/twitter-api-php) ### Installation -- copy the files to a directory on your webserver +- copy (or clone) the files to a directory on your webserver - copy (or rename) [config-dist.php](config-dist.php) to config.php and adjust the settings if you like (at least set a new password!) - for Apache: edit [.htaccess](.htaccess) and set `RewriteBase` to a path matching your installation directory - for nginx: have a rule similar to `try_files $uri $uri/ /index.php?$args;` for the microblog-location -- optional: modify the theme file [microblog.css](microblog.css) -- optional: enable crossposting to twitter by filling in app credentials in [config.php](config.php#L32-L35) (instructions there) -- optional: set an `app_token` to use with XML-RPC +- optional: modify the theme file [microblog.css](css/microblog.css) +- optional: enable crossposting to twitter by filling in app credentials in [config.php](config-dist.php#L33-L36) (instructions there) +- optional: set an `app_token` in [config.php](config-dist.php#L28) to use with XML-RPC ### To Do - test whether the [ping function](http://help.micro.blog/2017/api-feeds/) actually works - improve html rendering (?) -- maybe improve theming support by adding a themes dir, moving the CSS there and setting theme via config file +- support file attachments +- maybe improve theming support by adding a themes dir, moving the CSS there and setting theme via config file (started) - see issues ### Support my work |