You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

87 lines
2.2 KiB

7 years ago
5 years ago
5 years ago
7 years ago
5 years ago
5 years ago
  1. Quill
  2. =====
  3. [Micropub](https://micropub.net/draft/) client written in PHP.
  4. A hosted version is available to try at:
  5. https://quill.p3k.io/
  6. ## Dependencies
  7. - PHP
  8. - MySQL or SQLite
  9. - Composer for further dependency installation
  10. ## Setup
  11. - Follow the "Web Server Configuration" section
  12. - Run `composer install`
  13. - Copy `lib/config.template.php` to `lib/config.php` and adjust it
  14. - Import `schema/mysql.sql` (or `schema/sqlite.sql`)
  15. - Open the Quill URL in your Browser
  16. ### Web Server Configuration
  17. Set the document root to the "public" folder of this repo, and ensure all requests are routed through `public/index.php` if they don't match a file.
  18. #### nginx
  19. ```
  20. server {
  21. listen 80;
  22. server_name quill.dev;
  23. root /path/to/Quill/public;
  24. error_log logs/quill.error.log notice;
  25. try_files $uri /index.php?$args;
  26. location /index.php {
  27. fastcgi_pass php-pool;
  28. fastcgi_index index.php;
  29. include fastcgi_params;
  30. fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
  31. }
  32. }
  33. ```
  34. #### Apache .htaccess
  35. An `.htaccess` file is already located in the `public/` folder.
  36. ## Parameters
  37. Quill supports a couple of URL GET parameters which can be used to
  38. pre-configure it:
  39. - `me`: Author URL for auto-sign in
  40. - `dontask`: Set to `1` to skip the "Sign In" endpoint status page
  41. - `reply`: URL to pre-fill into the "Reply To:" field
  42. ## Contributing
  43. By submitting code to this project, you agree to irrevocably release it under the same license as this project.
  44. ## Credits
  45. Quill icon designed by [Juan Pablo Bravo from the Noun Project](http://thenounproject.com/term/quill/17013/).
  46. ## License
  47. Copyright 2013-2016 by Aaron Parecki and contributors
  48. Licensed under the Apache License, Version 2.0 (the "License");
  49. you may not use this file except in compliance with the License.
  50. You may obtain a copy of the License at
  51. http://www.apache.org/licenses/LICENSE-2.0
  52. Unless required by applicable law or agreed to in writing, software
  53. distributed under the License is distributed on an "AS IS" BASIS,
  54. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  55. See the License for the specific language governing permissions and
  56. limitations under the License.