]> www.dxcluster.org Git - spider.git/blob - UPGRADE.mojo
remove day/month/year from progress spots
[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 were, 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     wget -O - https://cpanmin.us | perl - --sudo App::cpanminus
47 or
48         sudo apt-get install curl
49         curl -L https://cpanmin.us | perl - --sudo App::cpanminus
50
51 You will need the following CPAN packages:
52
53         If you are on a Debian based system (Devuan, Ubuntu, Mint etc) that is reasonably new (I use Ubuntu
54         18.04 and Debian 10) then you can simply do:
55
56         sudo apt-get install libev-perl libmojolicious-perl libjson-perl libjson-xs-perl
57
58     or on Redhat based systems you can install the very similarly (but not the same) named
59         packages. I don't the exact names but using anything less than Centos 7 is likely to cause
60         a world of pain. Also I doubt that EV and Mojolicious are packaged for Centos at all.
61
62         If in doubt or it is taking too long to find the packages you should build from CPAN. Note: you may
63         need to install the essential packages to build some of these. At the very least you will need
64         to install 'make' (sudo apt-get install make) or just get everything you are likely to need with
65         sudo apt-get install build-essential.
66
67         sudo cpanm EV Mojolicious JSON JSON::XS
68         
69         # just in case it's missing
70         sudo apt-get install top
71
72 Please make sure that, if you insist on using operating system packages, that your Mojolicious is
73 at least version 7.26. Mojo::IOLoop::ForkCall is NOT LONGER IN USE! The current version at time
74 of writing is 8.36.
75
76 Login as the sysop user.
77
78 Edit your /spider/local/DXVars.pm so that the bottom of the file is changed from something like:
79
80 ---- old ----
81
82          # the port number of the cluster (just leave this, unless it REALLY matters to you)
83          $clusterport = 27754;
84
85          # your favorite way to say 'Yes'
86          $yes = 'Yes';
87
88          # your favorite way to say 'No'
89          $no = 'No';
90
91          # the interval between unsolicited prompts if not traffic
92          $user_interval = 11*60;
93
94          # data files live in 
95          $data = "$root/data";
96
97          # system files live in
98          $system = "$root/sys";
99
100          # command files live in
101          $cmd = "$root/cmd";
102
103          # local command files live in (and overide $cmd)
104          $localcmd = "$root/local_cmd";
105
106          # where the user data lives
107          $userfn = "$data/users";
108
109          # the "message of the day" file
110          $motd = "$data/motd";
111
112          # are we debugging ?
113          @debug = qw(chan state msg cron );
114
115 ---- to this: ----
116
117          # the port number of the cluster (just leave this, unless it REALLY matters to you)
118          $clusterport = 27754;
119
120          # your favorite way to say 'Yes'
121          $yes = 'Yes';
122
123          # your favorite way to say 'No'
124          $no = 'No';
125
126          # this is where the paths used to be which you have just removed
127          
128          # are we debugging ?
129          @debug = qw(chan state msg cron );
130
131 ---- new  ------
132
133 There may be other stuff after this in DXVars.pm, that doesn't matter. The point is to remove
134 all the path definitions in DXVars.pm. If this isn't clear to you then it would be better if
135 you asked on dxspider-support for help before attempting to go any further.
136
137 One of the things that will happen is that several files currently in /spider/data will be
138 placed in /spider/local_data. These include the user, qsl and usdb data files, the band and
139 prefix files, and various "bad" data files. I.e. everything that is modified from the base
140 git distribution. 
141
142 Now run the console program or telnet localhost and login as the sysop user.
143
144         export_users
145         bye
146
147 as the sysop user:
148
149    sudo service dxspider stop
150    or
151    sudo systemctl stop dxspider
152
153 having stopped the node:
154
155    mkdir /spider/local_data
156    git reset --hard
157    git pull
158    git checkout --track -b mojo origin/mojo
159
160 if you have not already done this:
161
162    sudo ln -s /spider/perl/console.pl /usr/local/bin/dx
163    sudo ln -s /spider/perl/*dbg /usr/local/bin
164
165 Now in another window run:
166
167         watchdbg
168
169 and finally:
170
171    sudo service dxspider start
172    or
173    sudo service systemctl start dxspider
174
175 You should be aware that this code base is now under active development and, if you do a 'git pull',
176 what you get may be broken. But, if this does happen, the likelihood is that I am actively working
177 on the codebase and any brokenness may be fixed (maybe in minutes) with another 'git pull'.
178
179 I try very hard not to leave it in a broken state...
180
181 Dirk G1TLH
182
183
184
185