Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 4.67 KB

README.md

File metadata and controls

63 lines (47 loc) · 4.67 KB
Raw

nastia-server

This software package provides a collection of automation scripts for running a home server. Originally implemented on the Raspbian Stretch Linux distribution running on a Raspberry Pi 3 B+.

For an in-depth presentation of the project, please visit: www.microfarad.de/pi-server

Unless stated otherwise within the source file headers, please feel free to use and distribute the full contents of this package or parts of it according to the GNU General Public License v3.0.

Nastia is the name of author's daughter.

The Scripts

Following is the list of available scripts:

  • Media stream:
    • photostream: Automatically fetches your media files from one or more pre-defined directories, renames them according to their EXIF date and stores them into monthly sub-directories. Detects and eliminates duplicate media files.
    • dropbox-photos: Automatically downloads photos from a Dropbox folder.
    • check-images: Checks image files for corruption.
  • Automated system backup:
    • backup-hdd: Performs an incremental backup of the storage hard-drive while mimicking the Apple Time Machine behavior.
    • backup-config: Creates a backup copy of important configuration files.
    • backup-sd: Creates a backup image of the Raspberry Pi's SD card to an external hard drive.
    • backup-files: Creates a backup copy of a directory to a local or remote SSH location using rsync.
  • Dynamic DNS dyndns: Communicates the server's public IP address to the Dynamic DNS service.
  • System diagnostics monitor: Runs extensive system diagnostics every night and sends an automated test report via email.
  • Fan control fan: Controls the CPU cooling fan over the Raspberry Pi's GPIO pin. This script runs as a service with service fan start.
  • UPS control ups: Reads the status of the UPS and ensures a safe shutdown upon power loss (see www.microfarad.de/pi-ups). This script runs as a service with service ups start.
  • Serial communication over Bluetooth bt-daemon: Sends text commends over a bluetooth interface and retrieves its answers. This script runs as a service with service bt-daemon start.
  • Serial console serial-cli.py: Serial console based on the pyserial Python module. Connects to a serial device with a specified baud rate and optional timestamps.
  • System configuration parameters are stored in the centralized configuration file under nastia-server.conf.
  • If not stated otherwise, the above scripts are executed unsing cron jobs which are configured under /etc/cron.d/nastia-server.

Dependencies

The following Linux packages need to be installed first:

  • sudo apt-get install rsync imagemagick libimage-exiftool-perl lynx msmtp python
  • sudo pip install speedtest-cli pyserial ilock

Installation

The directory structure of this repository reflects the Linux file system structure relative to its root directory /.

In order to install this package, copy the contents of the opt directory to your Linux file system. Also copy the cron, logrotate and systemd service configuration files into the respective etc sub-directories.

Finally, create a copy of the configuration file under /opt/nastia-server/etc/nastia-server.conf renaming it to nastia-server.local, then modify the parameters inside copied file to achieve your desired setup.