Nofu/README.md

# Nofu

 Nofu for **N**ot **O**nly **F**or **U**s is personal dashboard

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Instalation](#instalation)
- [Licence](#licence)


## Introduction

There are many impressive dashboards ([awesome-selfhosted](https://awesome-selfhosted.net/tags/personal-dashboards.html)), which are perfect for our needs. However, for non-technical people/geeks/computer enthusiasts/dev...., it can be difficult to understand all the features offered by these dashboards. That's why I created NOFU in 'scratch-an-itch' mode. Although it may not be perfect for everyone, it meets my needs and those of my family circle.

I also wanted a place where my family could find all my services with a quick documentation on my infrastructure (software used, what it's for, where it's located, where backups are stored...), in case I stop functioning one day. So that they can recover the family data or call someone to help them.

![screenshot](public/imgs/screenshots/screen_full_dark-light.webp)
![screenshot](public/imgs/screenshots/screen_compact_dark-light.webp)
![screenshot](public/imgs/screenshots/screen_icon_dark-light.webp)

## Features

* Simple to understand
* Easy customisation
* Minimal dependance
* No database
* Easy backup and deploy
* Static page
* Fast
* No JS or only for eye candy
* Responsive

## Instalation

### Manual

Classic git clone, run composer, create website with your web server, that's all.

#### Clone

```shell
git clone https://forge.leslibres.org/Knah-Tsaeb/Nofu.git
```

#### Install dep

```shell
composer install --no-dev
```

Serve public folder throw your web server.

### Docker

Clone, build and run.

#### Clone

```shell
cd /tmp
wget https://forge.leslibres.org/Knah-Tsaeb/Nofu/raw/branch/main/Dockerfile
```

#### Build

```shell
docker buildx build -t nofu:0.2.0 .
```

#### Run

```shell
docker run -d --restart unless-stopped -v nofu_data:/var/www/data -e TZ=UTC -p 8189:80 --name nofu nofu:0.2.0
```

## Ressources

  * <a href="https://www.svgrepo.com/svg/448401/docker"><img alt="docker icon" src="public/assets/icons/docker.svg" width="24"> svgrepo.com (MLP licence)</a>
  * <a href="https://www.svgrepo.com/svg/375064/question-mark"><img alt="docker icon" src="public/assets/icons/help.svg" width="24"> svgrepo.com (CC Attribution License)</a>
  * <a href="https://www.svgrepo.com/svg/56164/logout"><img alt="logout icon" src="public/assets/icons/logout.svg" width="24"> svgrepo.com (CCO licence)</a>
  * <a href="https://www.svgrepo.com/svg/195725/moon"><img alt="logout icon" src="public/assets/icons/moon.svg" width="24"> svgrepo.com (CCO licence)</a>
  * <a href="#"><img alt="docker icon" src="public/assets/icons/missing.svg" width="28"> Missing origin, need to find origin or change</a>
  * <a href="https://www.svgrepo.com/svg/172573/arrow-right-curve"><img alt="redirection icon" src="public/assets/icons/redirection.svg" width="24"> svgrepo.com (CCO licence)</a>
  * <a href="https://www.svgrepo.com/svg/260068/server"><img alt="docker icon" src="public/assets/icons/server.svg" width="24"> svgrepo.com (CCO licence)</a>
  * <a href="https://www.svgrepo.com/svg/17826/setting-gears"><img alt="docker icon" src="public/assets/icons/settings.svg" width="24"> svgrepo.com (CCO licence)</a>
  * <a href="https://www.svgrepo.com/svg/306622/qemu"><img alt="docker icon" src="public/assets/icons/vm.svg" width="24"> svgrepo.com (Logo License)</a>
  * <a href="https://www.svgrepo.com/svg/521261/web"><img alt="docker icon" src="public/assets/icons/web.svg" width="24"> svgrepo.com Logo (CC Attribution License)</a>
  * <a href="https://www.svgrepo.com/svg/105529/hard-drive-interior"><img alt="docker icon" src="public/assets/icons/webapp.svg" width="24"> svgrepo.com Logo (CC0 License)</a>

And some code from Stack Overflow :-)

## Licence

WTFPL

```
           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                   Version 2, December 2004
 
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
 
           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

 0. You just DO WHAT THE FUCK YOU WANT TO.

```