Skip to content

Commit 1368625

Browse files
committed
Update hardware page to include specs required for running PiNet as a virtual machine.
Also fixed README.md file
1 parent 77a4290 commit 1368625

File tree

2 files changed

+29
-8
lines changed

2 files changed

+29
-8
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,23 @@ The PiNet documentation website is built using Jekyll. If you would like to cont
33

44
The main site can be found at [http://PiNet.org.uk](http://PiNet.org.uk).
55

6-
#Running site locally
6+
## Found a mistake or want to contribute to the documentation?
7+
Check out the [PiNet documentation contribution page](http://pinet.org.uk/articles/CONTRIBUTING.html) for details on how to get involved!
78

8-
##Installing Jekyll and dependancies.
9+
# Running site locally
10+
11+
## Installing Jekyll and dependancies.
912
To run the site locally,
1013
- First [install Ruby](https://www.ruby-lang.org/en/documentation/installation/).
1114
- Then install bundler ```gem install bundler```.
1215
- Finally install Jekyll ```gem install jekyll```.
1316
- Grab the documentation site ```git clone https://github.com/PiNet/PiNet.github.io.git```
1417
- Use bundler to make sure you have all the required gems ```bundle install --binstubs```
1518

16-
##Running development server
19+
## Running development server
1720
To run the development server - ```./bin/jekyll serve watch```
1821
Then navigate to ```http://localhost:4000/``` in a web browser.
1922

2023

21-
#License
24+
# License
2225
The PiNet documentation is released under the MIT License. Check the [LICENSE](LICENSE) file for more information.

articles/installation/hardware.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,43 @@ In fact, PiNet requires extremely limited resources to run by default.
1616
There are though some limited use cases where the server does need to be powerful.
1717

1818
### So what type of PC hardware do I need for my PiNet server?
19-
This is an extremely wide ranging question and it is impossible to say. A few rough guidelines though for a class set (20) Raspberry Pis would be.
19+
This is an extremely wide ranging question and it is impossible to say. A few rough guidelines though for a class set (20) Raspberry Pis can be found below. They are split into Dedicated (if running PiNet on a dedicated machine directly on the hardware) or Virtualisation (if running PiNet/Ubuntu in a virtual machine on top of Windows/Mac OS/Linux).
2020

21-
#### Minimum
21+
#### Dedicated Minimum
2222
- Single core 1GHz processor (Intel Celeron or greater)
2323
- 1GB of RAM
2424
- 20GB of hard disk space
2525
- A gigabit ethernet port (100mbit/s is not officially supported)
2626

27-
#### Recommended
27+
#### Dedicated Recommended
2828
- Duel core 1.5GHz processor (Intel Pentium or greater)
2929
- 2GB of RAM
3030
- 40GB of hard disk space
3131
- A gigabit ethernet port (100mbit/s is not officially supported)
3232

33-
#### Large setup recommended (80+ Pis)
33+
#### Dedicated Large setup recommended (80+ Pis)
3434
- Duel core 2GHz processor (Intel Core I3 or greater)
3535
- 4GB of RAM
3636
- 40GB of hard disk space
3737
- A gigabit ethernet port (100mbit/s is not officially supported)
38+
39+
#### Virtualisation Minimum
40+
- Duel core 1.8GHz processor (Intel Core 2 Duo or greater)
41+
- 4GB of RAM (1.5GB allocated to PiNet/Ubuntu)
42+
- 20GB of hard disk space (free to be used by PiNet/Ubuntu)
43+
- A gigabit ethernet port (100mbit/s is not officially supported)
44+
45+
#### Virtualisation Recommended
46+
- Duel core 2.0GHz processor (Intel Core 2 Duo or greater)
47+
- 6GB of RAM (2.5GB allocated to PiNet/Ubuntu)
48+
- 40GB of hard disk space (free to be used by PiNet/Ubuntu)
49+
- A gigabit ethernet port (100mbit/s is not officially supported)
50+
51+
#### Virtualisation Large setup recommended (80+ Pis)
52+
- Duel core 2GHz processor (Intel Core I3 or greater)
53+
- 8GB of RAM (4GB allocated to PiNet/Ubuntu)
54+
- 40GB of SSD space (free to be used by PiNet/Ubuntu)
55+
- A gigabit ethernet port (100mbit/s is not officially supported)
3856

3957
For anything greater than 100 Raspberry Pis, it would be recommended to look into port trunking or 10gbit/s core networking.
4058

0 commit comments

Comments
 (0)