]> gb7djk.dxcluster.net Git - spider.git/blob - UPGRADE.mojo
Fix issues finding $main::data etc on clean install
[spider.git] / UPGRADE.mojo
1 There are the notes for upgrading to the mojo branch.
2
3 There is NO POINT in doing this at the moment unless you are running a node with many (>50)
4 users. It is the future, but at the moment I am testing larger and larger installations to
5 check that it a) still works as people imagine it should and b) it provides the improvement
6 in scaling that I am anticipating. There are no significant new features - yet. 
7
8 The BIG TICKET ITEM in this branch is that (potentially) "long lived" commands such as sh/dx
9 and commands that poll external internet resources now don't halt the flow of data through
10 the node. I am also using a modern, event driven, web socket "manager" called Mojolicious
11 which is considerably more efficient than what went before (but is not necessary for small
12 nodes). There are some 200-400 user nodes out there that will definitely see the difference
13 in terms of both CPU usage and general responsiveness. Using Mojolicious also brings the
14 tantalising possibility of grafting on a web frontend, as it where, to the "side" of a
15 DXSpider node. But serious work on this won't start until we have a stable base to work
16 on. Apart from anything else there will, almost certainly, need to be some internal data
17 structure reorganisation before a decent web frontend could be constructed.
18
19 Upgrading is not for the faint of heart. There is no installation script (but there
20 will be) so, for the time being, you need to do some manual editing. Also, while there is
21 a backward path, it will involve moving various files from their new home (/spider/local_data),
22 back to where they came from (/spider/data).
23
24 Prerequisites:
25
26         A supply of good, strong tea - preferably in pint mugs. A tin hat, stout boots, a
27         rucksack with survival rations and a decent miners' lamp might also prove comforting. I
28         enclose this link: http://www.noswearing.com/dictionary in case you run out of swear words.
29
30         An installed and known working git based installation. Mojo is not supported under CVS or
31         installation from a tarball. 
32
33         perl 5.10.1, preferably 5.14.1 or greater. This basically means running ubuntu 12.04 or
34         later (or one of the other linux distros of similar age or later). The install instructions are
35         for debian based systems. IT WILL NOT WORK WITHOUT A "MODERN" PERL. Yes, you can use
36         bleadperl if you know how to use it and can get it to run the node under it as a daemon
37         without resorting the handy URL supplied above. Personally, I wouldn't bother. It's
38         easier and quicker just to upgrade your linux distro. Apart from anything else things like ssh
39         ntpd are broken on ALL older systems and will allow the ungodly in more easily than something
40         modern.
41
42 Install cpamminus:
43
44         sudo apt-get install cpanminus
45 or
46         sudo apt-get install curl
47         curl -L https://cpanmin.us | perl - --sudo App::cpanminus
48
49 You will need the following CPAN packages:
50
51         sudo cpanm EV Mojolicious Mojo::IOLoop::ForkCall JSON JSON::XS
52         # just in case it's missing
53         sudo apt-get install top
54
55 Login as the sysop user.
56
57 Edit your /spider/local/DXVars.pm so that the bottom of the file is changed from something like:
58
59 ---- old ----
60
61          # the port number of the cluster (just leave this, unless it REALLY matters to you)
62          $clusterport = 27754;
63
64          # your favorite way to say 'Yes'
65          $yes = 'Yes';
66
67          # your favorite way to say 'No'
68          $no = 'No';
69
70          # the interval between unsolicited prompts if not traffic
71          $user_interval = 11*60;
72
73          # data files live in 
74          $data = "$root/data";
75
76          # system files live in
77          $system = "$root/sys";
78
79          # command files live in
80          $cmd = "$root/cmd";
81
82          # local command files live in (and overide $cmd)
83          $localcmd = "$root/local_cmd";
84
85          # where the user data lives
86          $userfn = "$data/users";
87
88          # the "message of the day" file
89          $motd = "$data/motd";
90
91          # are we debugging ?
92          @debug = qw(chan state msg cron );
93
94 ---- to this: ----
95
96          # the port number of the cluster (just leave this, unless it REALLY matters to you)
97          $clusterport = 27754;
98
99          # your favorite way to say 'Yes'
100          $yes = 'Yes';
101
102          # your favorite way to say 'No'
103          $no = 'No';
104
105          # this is where the paths used to be which you have just removed
106          
107          # are we debugging ?
108          @debug = qw(chan state msg cron );
109
110 ---- new  ------
111
112 There may be other stuff after this in DXVars.pm, that doesn't matter. The point is to remove
113 all the path definitions in DXVars.pm. If this isn't clear to you then it would be better if
114 you asked on dxspider-support for help before attempting to go any further.
115
116 One of the things that will happen is that several files currently in /spider/data will be
117 placed in /spider/local_data. These include the user, qsl and usdb data files, the band and
118 prefix files, and various "bad" data files. I.e. everything that is modified from the base
119 git distribution. 
120
121 Now run the console program or telnet localhost and login as the sysop user.
122
123         export_users
124         bye
125
126 as the sysop user:
127
128    sudo service dxspider stop
129
130 having stopped the node:
131
132    mkdir /spider/local_data
133    git reset --hard
134    git pull
135    git checkout --track -b mojo origin/mojo
136
137 if you have not already done this:
138
139    sudo ln -s /spider/perl/console.pl /usr/local/bin/dx
140    sudo ln -s /spider/perl/*dbg /usr/local/bin
141
142 Now in another window run:
143
144         watchdbg
145
146 and finally:
147
148    sudo service dxspider start
149
150 You should be aware that this code base is now under active development and, if you do a 'git pull',
151 what you get may be broken. But, if this does happen, the likelyhood is that I am actively working
152 on the codebase and any brokenness may be fixed (maybe in minutes) with another 'git pull'.
153
154 I try very hard not to leave it in a broken state...
155
156 Dirk G1TLH
157
158
159
160