107 lines
No EOL
3 KiB
Markdown
107 lines
No EOL
3 KiB
Markdown
# 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]()
|
|
|
|
## 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
|
|
git clone https://forge.leslibres.org/Knah-Tsaeb/Nofu.git
|
|
cd nofu
|
|
```
|
|
|
|
#### Build
|
|
|
|
```shell
|
|
docker buildx build -t nofu:0.1.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.1.0
|
|
```
|
|
|
|
## Ressources
|
|
|
|
* <a href="https://"><img alt="docker icon" src="public/assets/icons/docker.svg" width="32"> SVGICON</a>
|
|
* <a href="https://"><img alt="docker icon" src="public/assets/icons/docker.svg" width="32"> SVGICON</a>
|
|
* <a href="https://"><img alt="docker icon" src="public/assets/icons/docker.svg" width="32"> SVGICON</a>
|
|
* <a href="https://"><img alt="docker icon" src="public/assets/icons/docker.svg" width="32"> SVGICON</a>
|
|
* <a href="https://"><img alt="docker icon" src="public/assets/icons/docker.svg" width="32"> SVGICON</a>
|
|
* <a href="https://"><img alt="docker icon" src="public/assets/icons/docker.svg" width="32"> SVGICON</a>
|
|
* <a href="https://"><img alt="docker icon" src="public/assets/icons/docker.svg" width="32"> SVGICON</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.
|
|
|
|
``` |