https://github.com/emidev98/raspberry-home-server
Instructions on how to create your own home server with raspberrypi
https://github.com/emidev98/raspberry-home-server
homeserver raspberrypi rpi
Last synced: about 1 month ago
JSON representation
Instructions on how to create your own home server with raspberrypi
- Host: GitHub
- URL: https://github.com/emidev98/raspberry-home-server
- Owner: emidev98
- Created: 2023-02-25T11:44:03.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T11:44:18.000Z (over 2 years ago)
- Last Synced: 2025-05-10T09:11:20.999Z (5 months ago)
- Topics: homeserver, raspberrypi, rpi
- Homepage:
- Size: 341 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
On this repository you can find all the documentation from installation to full config on my Raspberry Pi comand by comand. Most of the resources are external, because I preffer to give credit to the people how created the tutorials.
## Necessity
I wanted to have a server to be able to **host websites, deploy websites, store files, have access to the servers cli and tunnel connections**. This features must be available to be able to connect from **internet** using a **domain name**.
One of the most important things for this project is to do not have to spend money on software licenses and be open source. The unique cost of this project must be the **Raspberry Pi 3 B+, SD Card 64GB, the electricity and internet connection (200 Mbps)**.
# 1 Raspbian Installation
The distro I use is [Raspbian Lite](https://www.raspberrypi.org/downloads/raspbian/) because I do not need any UI to interact with. The software to burn the image
in the SD is named [Rufus](https://rufus.ie/) because I am using a Windows OS.
## 1.1 Raspbian Configuration
If you want a exposed internet server you must conseider some important things depending of how paranoid are you with security, but for me these are fine:
- Delete pi user and create you own one with robust password.
- Use a DMZ [(demilitarized zone)](https://en.wikipedia.org/wiki/DMZ_(computing)) to save you internal network if someone access to you server.
- Open the only necessary ports to access from the internet to you server.
### 1.1.1 Static ip configuration
To configure the Raspbian static ip you must edit the **dhcpcd.conf**.
```
sudo nano /etc/dhcpcd.conf
# At the end of the file add this configuration with the interface name ip and routing ip
interface eth0
static ip_address=192.168.100.100/24
static routers=192.168.100.1
```
## 1.2 Current network configuration.
As I mentioned in the last point, its important to have a DMZ wich normally is setting up a firewall (as in my case) to separe the two networks and don't be able to even ping from internal network. The next image ilustre my current network configuration (the image is an example of my current network config):
## 1.3 Domain name
As I mentiones in the previous points everything must be free. For this part I found the page [Freenom](https://my.freenom.com/) which I used many times to get free domains with extension **.TK / .ML / .GA / .CF / .GQ**. Is easy only need to register and give some personal data because the domains are register on you name (no credit card needed).
## 1.4 The router configuration
I chose to open the less ports as it was possible, to do not be so exposed on the internet. The ports are:
- 22 TCP port: to connect using SSH.
- 80 TCP/UDP port: to connect the web server.
- 9898 UDP: for the OpenVPN server.
*The current reason that I am not using HTTPS (443) is because the webs I want to host are not using any authentication or personal information to be secure.
# 2 Server side Software
- **SSH** to connect to Raspberry PI CLI and send files.
- **OpenVPN** to create a Virtual Private Network.
- **Apache 2** to host websites.
## 2.1 SSH Configuration
SSH is already installed on Raspberry Pi you only have to activate it. This tutorial gives you the posibility to configure SSH command by command [SSH intro raspberry](https://itsfoss.com/ssh-into-raspberry/).
## 2.2 OpenVPN Installation
To install OpenVPN server I decided to follow the tutorial [How to setup and OpenVpn Server on a Raspberry Pi](https://dzone.com/articles/how-to-setup-an-openvpn-server-on-a-raspberry-pi). Which comes with a script to be executed in the Raspberry Pi and information for each screen.
## 2.3 Apache 2 Installation
To install Apache 2 is quiet easy only execute the command:
```
sudo apt install apache2
```
Obviously in the future you will need some modules when HTTPS or subdomains are used, but for now it works.
## 2.4 Webmin
Webmin its a web based tool witch allows you to manage the most important things in you system, like read the logs, check the current load status, modify users and do a lot more sysadmin tasks from a web based interface. To install this tool must add the repository to the sources list:
```
sudo nano /etc/apt/sources.list
# Add this line at the end of the file.
deb http://download.webmin.com/download/repository sarge contrib
```
Download the repository key and install it:
```
sudo wget http://www.webmin.com/jcameron-key.asc
sudo apt-key add jcameron-key.asc
```
At last update the packages and install the webmin:
```
sudo apt-get update
sudo apt-get install webmin
```
When all process is done, you must go to the web browser and search for **https://youraspbianinternalip:10000** and login with the used used to access the RaspberryPi using SSH. When you are logged in you must see a interface like that:
# 3 Client side software
- [PuTTY](https://www.putty.org/): to connect with SSH on CLI. (Windows)
- [WinSCP](https://www.putty.org/): to connect via SSH on GUI to transfer files easly. (Windows)
- [OpenVPN](https://openvpn.net/): to connect the VPN (Multi platform)
# 4 Deployment script
If you are a web developer, this script will be useful to deoploy GitLab branches in the webserver. I tried to create the most easy script to download the project, unzip, move to the server directory and delete the unnecesary files.
```bash
#!/bin/bash
# Variables declaration used to clone the project.
PROJECTID="web-curriculum-2"
PROJECTNAME="${PROJECTID}-master"
# Clone the project repository
wget https://gitlab.com/emidev98/$PROJECTID/-/archive/master/$PROJECTNAME.zip
# Unzip the project in the same directory
unzip $PROJECTNAME.zip
# Copy the project in the main apache directory
cp -r ./$PROJECTNAME/* /var/www/html
# Delete the remaining files in the unzip directory
rm -r $PROJECTNAME $PROJECTNAME.zip
```
Link to the **[GitLab repository](https://gitlab.com/emidev98/web-curriculum-2)** and the **[hosted website](http://emilian.cf/)**