readme.txt 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. --------------------
  2. LCTV Badges
  3. License: GPLv3
  4. --------------------
  5. *** SETUP ***
  6. Setup constants are in lctv_badges_init.php
  7. LCTV_CLIENT_ID and LCTV_CLIENT_SECRET are set in the environment to keep
  8. them private. This can be accomplished by placing the following in a
  9. .htaccess file:
  10. SetEnv LCTV_CLIENT_ID "thisisyourclientid"
  11. SetEnv LCTV_CLIENT_SECRET "thisisyourclientsecret"
  12. LCTV_DATA_PATH is the path to the folder where API tokens and cache will be
  13. stored. This folder must be writable by the server. It would be a good idea
  14. to use a folder below the server's public html path, so that cached user
  15. tokens aren't publicly accessible.
  16. LCTVAPI_CACHE_EXPIRES_IN is the amount of time in seconds before cached
  17. data expires. Default is 300, or 5 minutes.
  18. LCTV_REDIRECT_URL is the url the API should return user authentication codes
  19. to. Should be the url to authorize.php.
  20. LCTV_MASTER_USER is the master user account the API will use to make public
  21. queries. In order for any API request to work it needs an authorized user.
  22. You can authenticate this master account by visiting authorize.php.
  23. *** BADGE USAGE ***
  24. Detailed badge instructions can be found by visiting index.php.