README.md in private_pub-1.0.1 vs README.md in private_pub-1.0.2
- old
+ new
@@ -37,11 +37,34 @@
<%= javascript_include_tag "private_pub" %>
```
It's not necessary to include faye.js since that will be handled automatically for you.
+## Serving Faye over HTTPS (with Thin)
+To server Faye over HTTPS you could create a thin configuration file `config/private_pub_thin.yml` similar to the following:
+
+```yaml
+---
+port: 4443
+ssl: true
+ssl_key_file: /path/to/server.pem
+ssl_cert_file: /path/to/certificate_chain.pem
+environment: production
+rackup: private_pub.ru
+```
+
+The `certificate_chain.pem` file should contain your signed certificate, followed by intermediate certificates (if any) and the root certificate of the CA that signed the key.
+
+Next reconfigure the URL in `config/private_pub.yml` to look like `https://your.hostname.com:4443/faye`
+
+Finally start up Thin from the project root.
+
+```
+thin -C config/private_pub_thin.yml start
+```
+
## Usage
Use the `subscribe_to` helper method on any page to subscribe to a channel.
```rhtml
@@ -103,9 +126,14 @@
```
The signature and timestamp checked on the Faye server to ensure users are only able to access channels you subscribe them to. The signature will automatically expire after the time specified in the configuration.
The `publish_to` method will send a post request to the Faye server (using `Net::HTTP`) instructing it to send the given data back to the browser.
+
+
+## Project Status
+
+Unfortunately I have not had time to actively work on this project recently. If you find a critical issue where it does not work as documented please [ping me on Twitter](http://twitter.com/rbates) and I'll take a look.
## Development & Feedback
Questions or comments? Please use the [issue tracker](https://github.com/ryanb/private_pub/issues). Tests can be run with `bundle` and `rake` commands.