console-websocket-cf-plugin 0.0.1 → 0.0.2

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.
Files changed (2) hide show
  1. data/README.md +40 -2
  2. metadata +1 -1
data/README.md CHANGED
@@ -3,6 +3,44 @@
3
3
  This is a [CF](https://github.com/cloudfoundry/cf) plugin for connecting to the STDIN / STDOUT of a remote process (rails console for example) on Cloud Foundry whilst simultaneously running the intended application in the same container.
4
4
  It uses a binary written in Go on the server side to provide the websocket connection and also serve the application itself, if you wish to serve that up too.
5
5
 
6
- ## TL;DR Rails example
6
+ ## TL;DR example
7
7
 
8
- 1. Install the Gem
8
+ 1 - Install the console-websocket-cf-plugin gem
9
+
10
+ ```
11
+ $ gem install console-websocket-cf-plugin
12
+ ```
13
+
14
+ 2 - Copy the pre-built linux binary from the Github repo in to the root of your Rails app
15
+
16
+ ```
17
+ $ cd my_rails_app
18
+ $ wget https://github.com/danhigham/console-websocket-cf-plugin/blob/master/console-server/console-server-linux-amd64?raw=true
19
+ ```
20
+
21
+ 3 - Modify the application manifest, note the 'command' property
22
+
23
+ ```yml
24
+ ---
25
+ applications:
26
+ - name: rails-console-test
27
+ memory: 256M
28
+ instances: 1
29
+ host: rails-console-test
30
+ domain: cfapps.io
31
+ path: .
32
+ command: ./console-server-linux-amd64 -console-process="rails c" -main-process="bundle exec rails s -p 8080"
33
+ ```
34
+
35
+ The processes that are started by the console-server binary are completely configurable, you could for example just run 'bash' for the console process. If you wish to make the application available, mounted at /, then it needs to be bound to port 8080, this is the port console-server expects to proxy requests to.
36
+
37
+ 4 - Push the app
38
+
39
+ ```
40
+ $ cf push --reset
41
+ ```
42
+
43
+ 5 - Start a console
44
+ ```
45
+ $ cf console <app name>
46
+ ```
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: console-websocket-cf-plugin
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors: