updated readme.md
[scripts.git] / shelr / README.md
1 Quick shelr howto
2 =================
3
4 This is how to make automatic recordings without the hassle to type yourself (and fail and start over again).
5
6 Todo/Ideas
7 ==========
8
9 * automatically split window and output all comments starting with ":" to one window, and all other cmds to another one
10
11 Before recording
12 ----------------
13
14 * use zsh and _not_ bash, cause zsh+ohmyzsh autosets the window title to the running command 
15 * put DISABLE_CORRECTION="true" in .zshrc  (otherwise zsh might ask you for correction where it is not needed)
16 * turn off fancy shell prompts
17 * i use a custom "demo" user for recordings, with a clean .zshrc (see above) 
18
19 Setup shelr to use the ttyrec backend
20 -------------------------------------
21
22 I realized that the bad timing i encountered earlier was due the default shelr backend "script".
23 I changed it to "ttyrec" and now the timing is ok.
24 please try above shelr play cmd again with updated recording.
25 see [upload to shelr is currently broken](https://github.com/shelr/shelr/issues/21) 
26
27     sudo apt-get install ttyrec
28     shelr backend ttyrec
29
30
31 Record
32 ------
33
34 * use max. 132x43 resolution in shell
35
36
37     sudo su - demo
38
39     rm -rf ~/leap/demo/example.org
40     rm -rf ~/leap/demo/leap_cli
41     rm -rf ~/leap/demo/leap_platform
42  
43     shelr record   # choose a short, intuitive title (use the first comment in the script) 
44
45
46 * in another termial start: 
47
48
49      ./shelr-screencast.sh setup/setup.sh
50
51
52 Upload
53 ======
54
55 * before uploading, edit "meta" and change following keys:
56
57      `cd /home/demo/.local/share/shelr/RECORD_ID
58      sed -i "s/`hostname`/demobox/g" meta`
59
60 * uploading sucks. you will always get an 500 error, but sometimes the vid yet shows up on http://shelr.tv. 
61   i couldn't login using github oauth, if anyone have an openid account, please try.
62
63
64      shelr setup xxxxxxxx   # setup upload api key (see pwstore)
65      shelr push RECORD_ID
66
67 * Description: "see https://leap.se for more details"
68 * Tags: "leap, bitmask"
69 * you can always edit the description, tags and title later
70
71 Resetting demo machines
72 ========================
73
74 * connect to the pistoncloud DC vpn, and souce your credentials for the 
75 * cd to your leap_pistonadmin working dir
76 * revert the instances using YOUR key !
77
78
79     for h in chameleon panda seahorse; do ./revert_instance_from_snapshot.sh -i ${h}.testing.bitmask.net -s ${h}_gold -k $USER; done
80
81
82 * NOTE: you need to wait maybe 5 minutes for the nodes to be restarted
83
84