README.md 3.31 KB
Newer Older
Philipp's avatar
Philipp committed
1
# Fidian
Philipp's avatar
Philipp committed
2

Philipp's avatar
Philipp committed
3
Installscript for setting up a Fido node (or point..) using binkd, husky and golded.
4

Philipp's avatar
Philipp committed
5
6
# RaspberryPi Image

Philipp's avatar
Philipp committed
7
8
You can [download a Raspberry Pi SD-Card Image](https://www.kuehlbox.wtf/fidian#download) 
based on the standard Raspbian (aka RaspiOS) Image.  
Philipp's avatar
Philipp committed
9
10
11
This will automatically download and start fidian setup when you first login as 
the default user "pi" via console or SSH.

Philipp's avatar
Philipp committed
12
13
Nothing else is done. It's a completely fresh Raspbian installation. 
So, the following steps are strongly adviced:
Philipp's avatar
Philipp committed
14
15
16
17
18
19
20
21
22
23
24
25

1. Run `sudo raspi-config` to change the password for user *"pi"*, 
   setup your localisation options and most important: 
   **Expand your filesystem!** (at the *"Advanced Options"* submenu)
2. Update your Raspbian base system:  
`sudo apt update`  
`sudo apt upgrade`
3. You could also think about further securing the SSH server, silencing 
   syslog to safe your SD-Card, setting up dyndns and portforwarding, so you 
   can receive crashmail, but that's beyond the scope of this manual..

# Manual Installation
26
## interactive
Philipp's avatar
Philipp committed
27
28
29
    wget https://kuehlbox.wtf/fidosetup.sh
    sudo bash fidosetup.sh
    rm fidosetup.sh
30
31
32

## Headless

Philipp's avatar
Philipp committed
33
34
35
36
37
For non-interactive installation, add a file 
[fidoconfig.txt](https://gitlab.ambhost.net/stimpy/scripts_fidian/blob/master/fidoconfig.txt)
to the same folder, where the 
[fidosetup.sh](https://gitlab.ambhost.net/stimpy/scripts_fidian/blob/master/fidosetup.sh)
is located.  
38
39

Use the included 
Philipp's avatar
Philipp committed
40
[fidoconfig.txt](https://gitlab.ambhost.net/stimpy/scripts_fidian/blob/master/fidoconfig.txt)
41
as an example and template...
Philipp's avatar
Philipp committed
42

Philipp's avatar
Philipp committed
43
44
45
To add more than one link, copy *"fidoconfig.txt"* to *"fidoconfig2.txt"*, 
*"fidoconfig3.txt"* ... (up to 10 links allowed)

Philipp's avatar
Philipp committed
46
47
48
49
50
51
52
# (Re-)config

    fidoconfig.sh

# Uninstall

    sudo fidouninstall.sh
53

Philipp's avatar
Philipp committed
54
55
56



57
58
59
60
61
62
# Configuration Parameters explained
No matter whether, you're running *fidosetup.sh*, *fidoconfig.sh* or manually 
writing a headless configuration file *fidoconfig.txt*, it all comes down to 
these parameters:

## LINK_NAME
Philipp's avatar
Philipp committed
63
64
Free text identifier for this link.  
*eg: FidoNet*
65
66
67
68
69

## LINK_DOMAIN
Domain identifier (used internally to distinguish different links)  
While this is technically free text, but you should still use the standards 
provided by your uplink.  
Philipp's avatar
Philipp committed
70
*eg: fidonet*
71
72
73

## YOUR_NAME
Your full first- and last name.  
Philipp's avatar
Philipp committed
74
*eg: John Doe*
75
76
77

## YOUR_AKA
Your AKA, assigned by your uplink.  
Philipp's avatar
Philipp committed
78
*eg: 2:240/5853.5*
79
80
81

## YOUR_SYSTEM
Free text to identify your system. Most common: Name of your BBS or just your name.  
Philipp's avatar
Philipp committed
82
*eg: Johnny's Fido System*
83
84
85
86

## YOUR_LOCATION
Free text to identify your location.  
You're kindly asked to use a format like this: City, country.  
Philipp's avatar
Philipp committed
87
*eg: Frankfurt, germany*
88

Philipp's avatar
Philipp committed
89
## YOUR_HOSTNAME
90
If your system is reachable from the internet, please enter your FQDN here.  
Philipp's avatar
Philipp committed
91
*eg: your.domain.com*
92
93
94

## UPLINK_HOST
The FQDN or IP of your uplink.
Philipp's avatar
Philipp committed
95
*eg: kuehlbox.wtf*
96
97
98

## UPLINK_PORT
Port number of uplink's binkd.  
Philipp's avatar
Philipp committed
99
Leave empty for default: *24554*
100
101
102

## UPLINK_AKA
The AKA of your uplink.  
Philipp's avatar
Philipp committed
103
*eg: 2:240/5853*
104
105
106

## SESSION_PASSWORD
The session / binkp password provided by your uplink.  
Philipp's avatar
Philipp committed
107
*eg: SECRET123*
108
109
110

## PACKET_PASSWORD
The packet password provided by your uplink.  
Philipp's avatar
Philipp committed
111
Leave empty to use `SESSION_PASSWORD`
112
113
114

## AREAFIX_PASSWORD
The areafix password provided by your uplink.  
Philipp's avatar
Philipp committed
115
Leave empty to use `PACKET_PASSWORD`
116
117
118

## FILEFIX_PASSWORD
The filefix password provided by your uplink.  
Philipp's avatar
Philipp committed
119
Leave empty to use `AREAFIX_PASSWORD`
120