diff --git a/.gitignore b/.gitignore index 45ddf0a..8b03c06 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ site/ +.DS_Store diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..e43b0f9 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/docs/config/bpq.md b/docs/config/bpq.md index 5e8c06e..5efbb78 100644 --- a/docs/config/bpq.md +++ b/docs/config/bpq.md @@ -1,4 +1,111 @@ # BPQ -Configure BPQ this way: - * Badly, just like everyone else. +I assume you have already [installed](../install/bpq.md) bpq from the repo. + +## Configuration File + +The configuration file I ship in the repo, there are hopefully some obvious fields to fill out. Once all the below holes are filled, you should be able to log in either with [QtTermTCP](../clients/qtttcp.md) or in your web browser at 127.0.0.1:8008, assuming you're on the same computer as the node. + +| Field | Example | Purpose +| ----- | ------- | ------- +| NODECALL | MM0RFN | The callsign your node shall identify as +| NODEALIAS | RFNNOD | The alias a calling NET/ROM station can use to connect directly to you +| LOCATOR | IO87dc | A 6 figure Maidenhead square where you are +| PASSWORD | test123 | A sysop password for configuration activities +| AUTOSAVE | 1 | Autosave the NET/ROM Nodes Table on shutdown +| NODESINTERVAL | 30 | Interval between NET/ROM NODES broadcasts in minutes +| MINQUAL | 50 | The minimum quality of NET/ROM node included in your NODES broadcasts. +| CTEXT | `Hi you look great! ***` | Text displayed when a user connects + +### Ports + +Port configs in BPQNode aren't too complicated. A common Gotcha is that you configure a port specific broadcast and end up double-broadcasting, both the node master broadcast and the port specific one. + +#### KISS + +A common port entry for a [NinoTNC](../modems/ninotnc.md) specifically (but also, more generally, a KISS Modem) looks like: + +``` +PORT + PORTNUM=1 + ID=VHF + TYPE=ASYNC + PROTOCOL=KISS + KISSOPTIONS=ACKMODE + COMPORT=/dev/ttyACM0 + SPEED=57600 + FRACK=4000 + PACLEN=150 + DIGIFLAG=0 + QUALITY=192 + MINQUAL=20 +ENDPORT +``` + +Key settings to observe are the `COMPORT`, which should be the serial port of the device, and `SPEED`. For a NinoTNC this is always 57600, but for QtSoundModem, Direwolf or older hardware may be 9600 or something else. Check your modem configuration! + +`QUALITY` sets the assumed quality of connections coming in - I recommend higher quality (up to 200) for higher speed links. Setting this to 0 will disable NET/ROM on the port, and this is current recommended standard practise on HF within the UK Packet Radio Network. + +#### Telnet + +BPQ's Telnet Port sets the TCP Ports for Telnet, FBB and HTTP connetions, alongside the username and password. This will come in useful when using [QtTTCP](../clients/qtttcp.md) as a monitor and control application. + +``` +PORT + PORTNUM=9 + ID=Telnet + DRIVER=Telnet + CONFIG + LOGGING=1 + CMS=1 + DisconnectOnClose=1 + TCPPORT=8010 + FBBPORT=8011 + HTTPPORT=8008 + LOGINPROMPT=user: + PASSWORDPROMPT=password: + MAXSESSIONS=10 + CTEXT=Thanks for connecting\n Enter ? for list of commands\n\n + USER=username,xxxxxxxx,m0aaa,,SYSOP +ENDPORT +``` + +`USER` is the key configuration to change here - change `username` to your desired administrator username, `xxxxxxx` to the password and `m0aaa` to the callsign of the administrator. + +## Mail Configuration + +Mail configuration isn't easy to get your head round! I'm still not clear on it +all, and I think many others are in the same boat. It's done through the browser +instead of on the command line, which makes it slightly more approachable. + +Navigate to `http://localhost:8008`, assuming your HTTPPORT is set to 8008. This +will present you with the below view: + +![BPQ Node Main page](../static/img/node-main.png) + +Select 'Mail Mgmt' and log in with the details you put in `USER`. The starting +point here is 'Configuration'. + +### Configuration to Send & Receive + +The configuration tab is your starting point. You need a 'Hierarchical' +address, this will tell other systems where you are and help the network send +things to you. It's similar to the domain of your email, like `@gmail.com`. + +Set your BBS call - this will either be your personal callsign or an allocated +GB7xxx series callsign from the ETCC. + +Hierarchical addresses in the UK take the following format: + +`#xx.GBR.EURO` + +Where xx is a number that defines your region. You can find your region with +[this map](). + +I recommend unticking `Send System Msgs to SYSOP call` and ticking `Don't hold +Messages From New Users`. + +### Forwarding to Neighbours +### Users + + diff --git a/docs/linux.md b/docs/linux.md index 69ad91b..2a8d196 100644 --- a/docs/linux.md +++ b/docs/linux.md @@ -27,11 +27,21 @@ There are hundreds, if not thousands, of Linux Distributions all with different There's a common misconception that Linux is for command line users only, or that you need to be proficient in the command line to be able to drive it. This is no more true in Linux than it is for MacOS and Windows - there are a number of tasks that some may find more efficient to do via the command line interface (CLI), but there are usually multiple ways to skin the cat. -Most of my advice will take the form of things to run in the command line, but I am endeavouring to diversify so things are more approachable. +Much of my advice will take the form of things to run in the command line, as this is often the way I interact with my computers, but I am endeavouring to diversify so things are more approachable. If you're running the Raspberry Pi, it's most likely you have [Raspberry Pi OS](https://www.raspberrypi.com/software/) with a desktop - there'll be a background, a menu in the top left etc. It might not look familiar, but to a keen explorer it should look approachable at the very least. +<<<<<<< Updated upstream If you're running Debian, during install we'll ask you what graphical desktop environment you want to install, if any. This is the desktop you boot in to - unlike Windows, there are multiples available for Linux. As a beginner, I strongly recommend [KDE](https://kde.org) - it is most Windows like and is pretty full featured. If you're running Ubuntu, typically you install an Ubuntu derivative focussed on a specific desktop environment - perhaps [Kubuntu](https://kubuntu.org) for KDE. +======= +If you're running Debian, during install we'll ask you what graphical desktop +environment you want to install, if any. As a beginner, I strongly recommend +[KDE](https://kde.org) - it is most Windows like and is pretty full featured. If +you're running Ubuntu, typically you install an Ubuntu derivative focussed on a +specific desktop environment - perhaps [Kubuntu](https://kubuntu.org) for KDE. +For older hardware, I'm a big fan of [LXDE](https://lxde.org) - it's simple and +fast. +>>>>>>> Stashed changes ## Applications and Repositories @@ -47,9 +57,25 @@ To install from the command line, the standard command would be `apt install x` ### Graphical App Store Frontend -Instead of using `apt install x`, it is possible to run a graphical piece of software. One I recommend is 'Synaptic' - you might have it installed already, or you might have to quickly run `apt install synaptic` in the command line to get yourself the software. +Instead of using `apt install x`, it is possible to run a graphical piece of +software. + +#### Raspberry Pi + +The Raspberry Pi ships with a GUI through which you can install packages. It +lives in the Raspberry Pi menu (top left, Raspberry Pi icon), Preferences, +Add/Remove software. + +#### Other systems + +Have a little look through your application launcher menu to see if there is an +app catalogue, application store, package list or similar. If nothing is there, +then you might need to look to install something. + +One I recommend is 'Synaptic' - you might have it installed already, or you +might have to quickly run `apt install synaptic` in the command line to get +yourself the software. -Have a little look through your application launcher to see if there is an app catalogue, application store, package list or similar. On the Raspberry Pi, it's as below. To find it, go to the Raspberry Pi menu (Raspberry Icon, Top Left), Preferences and select Add/Remove software. @@ -59,7 +85,7 @@ On the Raspberry Pi, it's as below. To find it, go to the Raspberry Pi menu (Ras In a Windows system, the very top of your computer's filesystem is most often the C Drive, represented as C: commonly. Windows also neatly shows other drives as similar folder structures - CD Drives often start at D:, Floppy drives at A:. -In Linux we follow a documented filesystem hierarchy, starting at the root of the drive, commonly labelled as `/`. Everything else on the system is presented as a file or a folder under `/`. This includes CD Roms, Hard drives which present as folders, serial & USB devices which present as files and more. +In Linux we follow a different filesystem hierarchy, starting at the 'root' of the drive, commonly labelled as `/`. Everything else on the system is presented as a file or a folder under `/`. This includes CD Roms, Hard drives which present as folders, serial & USB devices which present as files and more. Paths always start with a `/`, and if it's a folder it will end with a `/` to indicate there is more depth below. @@ -146,7 +172,7 @@ In all these programs, you can find `/etc/` by typing `/etc` in the navigation b #### Command Line -Every Debian system ships with one called `nano` which is relatively approachable. +Every Debian system ships with a text editor called `nano` which is relatively approachable. You open your file directly, so to edit the BPQ config file, run `sudo nano /etc/bpq32.cfg`. This translates to: `As root user, open nano to edit /etc/bpq32.cfg` @@ -180,4 +206,4 @@ This can be read as the device is owned by root and accessible by the group `dia To add your user to the dialout group, you may need to run the usermod command as mentioned above. To add my user hibby, it would be `usermod -aG dialout hibby`. As this command needs to be run as the root user, we probably need to run `sudo usermod -aG dialout hibby`. -For this change to take effect, you will need to log out and log back in again. +For this change to take effect, you will need to log out and log in again. diff --git a/docs/static/img/node-main.png b/docs/static/img/node-main.png new file mode 100644 index 0000000..94ebb55 Binary files /dev/null and b/docs/static/img/node-main.png differ