mirror of
https://github.com/benapetr/stikkit.git
synced 2025-04-26 04:51:09 -05:00
Added configuration file doco
Bit more detailed configuration file doco added to ensure it's obvious to new users - I had to take a look at the source code to know which files do which. This prevents others from having to do the same
This commit is contained in:
parent
14ad63ba98
commit
c2aa1ca3d1
12
README.md
12
README.md
@ -50,6 +50,18 @@ url is an url to stikked server for example, if your server is http://something.
|
|||||||
|
|
||||||
The url parameter can be stored to configuration file (stikkit will ask you in case there is none in config file)
|
The url parameter can be stored to configuration file (stikkit will ask you in case there is none in config file)
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
=====
|
||||||
|
|
||||||
|
The default configuration pulls the URL from /etc/stikkit/url - however, the better approach is to create your own config directory. The stikkit software will look for ".stikkit" in your home directory.
|
||||||
|
|
||||||
|
Within this directory, there are a few key files worth creating.
|
||||||
|
|
||||||
|
- *url* - Contains your base installation URL for stikked
|
||||||
|
- *apikey* - If your stikked installation requires an API key, save it in here
|
||||||
|
- *expiry* - The default expiry time (in minutes) for a paste, if needed
|
||||||
|
- *author* - The default author name if you wish to use one
|
||||||
|
|
||||||
Tips
|
Tips
|
||||||
=====
|
=====
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user