Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 4.48 KB

README.md

File metadata and controls

76 lines (58 loc) · 4.48 KB
Raw

nanoon

The aim of this project is to experiment ways to install/remove/re-install/upgrade servers, this is useful to reduce dependency to companies who harvest data. Tested only on debian, but should work on any linux distribution and even Windows and OSX with a bit of effort.

State of the project:

  • This is currently a work in progress project. You can expect to run all with one command and configure most of the servers without too many problems.
  • This project is for server administrator willing to build a collection of privacy server and keep them running for them, family or friends.

Knowledge you need to use this project:

  • You need basic terminal usage knowledge to start the installation.
  • You need a good terminal usage knowledge to fix issues and make sure everything runs fine.
  • You need to know how each server logic works to make the right configurations.

*************containers list with pack and link ******************

Why use nanoon:

  • If you want to install many servers on the same machine but you like to not do extreme efforts.

How it works:

  • This project use many docker images to make services accessible from anywhere. All dockers are sorted by "pack". All dockers communicate on the internet via https.

What do you get with this project:

  • More control other your own data (import/export - change your service provider at will - Only you and the administrator can access your data)
  • Ability to reduce by a lot your dependency to big companies (less tracking, less ads, better battery life, your data are not shared secretly between private companies and governments)

Recommended hardware:

  • CPU : core i5 2500k, i3 8100, ryzen 3 2200g.
  • RAM : 8go.
  • DISK : one 128 SSD for servers, 1+ large HDDs for data.
  • Internet : Fastest internet you can get. I would recommend fiber(FFTH) if you plan to send data to other users, upload becomes critical. A 100/50 connection might not be enough if you have many users.
  • Router: If you self host you need to open port 80 and 443. (1194 for openvpn, 22222 for git ssh, 22000 for syncthing)

My test machine is a 6 core intel 6700k with 16go of ram. I only gave 2 cores + HT and it seems enough to run all services together without problems. This is of course while running all the servers at once, if you remove heavy servers you can use a weaker machine.

Requirements:

  • Dependencies : linux x64, docker-ce, docker-compose, git
  • Get a valid domain name that points to your installation ip address

How to use this:

  • git clone https://github.com/sinbades/nanoon.git
  • cd nanoon
  • open install.sh with your favourite text editor(nano, vim, textEditor...) and adapt filesdir, configdir, interface plus letencrypt email and domain.
  • sudo ./install.sh
  • access your server at serveradress:port(use docker ps -a to know your service port) or https://service.yourdomain.extension (check install.sh to know your service name)

What works so far:

  • Installation : install dependencies then run install.sh
  • Removal: not done. Use docker to clean all containers and images then remove install and config directories. (commands are easy to find online)
  • Backup: use backup.sh
  • Reinstall: not done. Import you save data in the correct configuration directory.
  • Upgrade: automatic using docker watchtower image.

Usage issues:

  • You have to enter each server and configure to your likes, it is a time-consuming task if you want to understand all the servers.
  • Upgrade issue with nextcloud : -cron might disapear. You have to install.sh again to fix this. -nextcloud disable all apps on update. You have to enter each section to enable your app one by one. Only one app can be enable at once and there is no "queue".
  • I have not set-up containers to send mail, this is untested

Where will it go: I plan to add more containers depending for my own needs.

I plan to test only servers with mail integration I consider necessary. My test machine is also a linux htpc gaming VFIO remote gaming.

Deep issues I will not fix : Administrator has complete control over anything on the server. Trust goes from big companies to the administrator.

Technical: I'm looking for a better solution to improve the installation and offer server selection at installation. I'm also looking for people willing to support this project, give me feedback, bring ideas, bring thinking or technical critism.

Inspiration comes from my own life experience plus initiatives like Framasoft, Yunohost and people like Edward Snowden. Thanks to all the containers maintainers and all the programs used for this project.