local_pac 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +49 -0
- data/lib/local_pac/version.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
|
@@ -18,6 +18,8 @@ Or install it yourself as:
|
|
|
18
18
|
|
|
19
19
|
## Usage
|
|
20
20
|
|
|
21
|
+
### Serving proxy.pacs
|
|
22
|
+
|
|
21
23
|
You need to place your proxy.pac in one of the following directories:
|
|
22
24
|
|
|
23
25
|
* $HOME/.config/pacfiles/
|
|
@@ -57,6 +59,49 @@ systemd-files provided by the gem:
|
|
|
57
59
|
* share/system/local_pac.socket
|
|
58
60
|
* share/system/local_pac.service
|
|
59
61
|
|
|
62
|
+
|
|
63
|
+
There are some options supported by `serve`. Please use `local_pac help serve` to get a full and up-to-date overview.
|
|
64
|
+
```
|
|
65
|
+
$ local_pac help serve
|
|
66
|
+
Usage:
|
|
67
|
+
local_pac serve
|
|
68
|
+
|
|
69
|
+
Options:
|
|
70
|
+
[--access-log=ACCESS_LOG] # File to write access log to
|
|
71
|
+
[--port=N] # The port the server listens on
|
|
72
|
+
# Default: 8000
|
|
73
|
+
[--config-file=CONFIG_FILE] # Config file
|
|
74
|
+
[--log-level=LOG_LEVEL] # Log level for ui logging
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Initialize environment
|
|
78
|
+
|
|
79
|
+
To initialize your environment, you can use `local_pac init`. To overwrite
|
|
80
|
+
existing files add the `--force`-flag: `local_pac init --force`.
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
$ local_pac init
|
|
84
|
+
W, [2014-02-14T12:52:41.980670 #5343] WARN -- : Repository "/home/user/.local/share/local_pac/run" already exists. Do not create it again!.
|
|
85
|
+
W, [2014-02-14T12:52:41.983601 #5343] WARN -- : Repository "/home/user/.local/share/local_pac/log" already exists. Do not create it again!.
|
|
86
|
+
W, [2014-02-14T12:52:41.986188 #5343] WARN -- : Repository "/home/user/.local/share/local_pac/data" already exists. Do not create it again!.
|
|
87
|
+
W, [2014-02-14T12:52:41.988631 #5343] WARN -- : File "/home/user/.local/share/local_pac/data/hooks/pre-receive" already exists. Do not create it again!.
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### Config variables
|
|
92
|
+
|
|
93
|
+
To make debugging a little bit easier you can view the config values used by
|
|
94
|
+
`local_pac` by running `local_pac config`.
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
option | value
|
|
98
|
+
-------------------- + --------------------------------------------------------------------------------
|
|
99
|
+
log_sink | /home/user/.local/share/local_pac/log
|
|
100
|
+
local_storage | /home/user/.local/share/local_pac/data
|
|
101
|
+
pid_file | /home/user/.local/share/local_pac/run/pid
|
|
102
|
+
gem_path | /home/user/.gem/ruby/1.9.3, /opt/rubies/1.9.3/lib/ruby/gems/1.9.1
|
|
103
|
+
```
|
|
104
|
+
|
|
60
105
|
## Reading
|
|
61
106
|
|
|
62
107
|
A good website to support you writing proxy.pac-files is:
|
|
@@ -67,6 +112,10 @@ http://findproxyforurl.com.
|
|
|
67
112
|
* Add feature: Compress proxy.pac-files before delivering them
|
|
68
113
|
* Improve API to support further functionality
|
|
69
114
|
|
|
115
|
+
## Copyright
|
|
116
|
+
|
|
117
|
+
2014, Dennis Günnewig (VR Netze GmbH, http://www.vrnetze.de)
|
|
118
|
+
|
|
70
119
|
## Contributing
|
|
71
120
|
|
|
72
121
|
1. Fork it ( http://github.com/<my-github-username>/local_pac/fork )
|
data/lib/local_pac/version.rb
CHANGED