Update README

This commit is contained in:
Knah Tsaeb 2024-07-02 16:49:59 +02:00
parent 40ce40b358
commit 8f4134ebb8

View file

@ -6,7 +6,10 @@
- [Introduction](#introduction) - [Introduction](#introduction)
- [Features](#features) - [Features](#features)
- [Instalation](#instalation) - [Install](#install)
- [Data dir structure](#data_dir_structure)
- [Backup and restore](#backup_and_restore)
- [Ressources](#ressources)
- [Licence](#licence) - [Licence](#licence)
@ -29,10 +32,10 @@ I also wanted a place where my family could find all my services with a quick do
* Easy backup and deploy * Easy backup and deploy
* Static page * Static page
* Fast * Fast
* No JS or only for eye candy * Minimal JS (no external file)
* Responsive * Responsive
## Instalation ## Install
### Manual ### Manual
@ -54,17 +57,15 @@ Serve public folder throw your web server.
### Docker ### Docker
Clone, build and run. Build image and run.
#### Clone #### Build
```shell ```shell
cd /tmp cd /tmp
wget https://forge.leslibres.org/Knah-Tsaeb/Nofu/raw/branch/main/Dockerfile wget https://forge.leslibres.org/Knah-Tsaeb/Nofu/raw/branch/main/Dockerfile
``` ```
#### Build
```shell ```shell
docker buildx build -t nofu:0.2.1 . docker buildx build -t nofu:0.2.1 .
``` ```
@ -77,6 +78,76 @@ docker run -d --restart unless-stopped -v nofu_data:/var/www/data -e TZ=UTC -p 8
Open http://127.0.0.1:8189 Open http://127.0.0.1:8189
## Data dir structure
### Assets
#### CSS
You can customize Nofu with your personal css. Just create /data/assets/css/user.css and re-import user file from settings page.
#### JS
Same with js, but in /data/assets/js/user.js.
### Imgs
#### Screenshots
Put screenshot of your service.
#### Favicons
Put favicon of your service. If you can prefer 128x128 favicon size (or higher).
### Services file
The services file contain a list of your service. Is simple text file, you can edit it with simple text editor (notepad, Pluma, Kate, Vim, Nano....). Nofu use[YAML](https://en.wikipedia.org/wiki/YAML) markup.
Create new file "/data/services.yaml" and edit it or create it localy and upload after on your server.
Example
```yaml
- title: Wikipedia
screenshot: wikipedia.png
favicon: wikipedia.png
link: https://en.wikipedia.org/wiki/Dashboard_(computing)
appHome: https://www.mediawiki.org/wiki/MediaWiki
location: Web
desc: Wikipedia, the free encyclopedia
type: webapp
```
- Title : name of your service
- Screenshot : name of your screenshot (locate in /data/imgs/screenshots/yourfile.png)
- favicon: name of your screenshot (locate in /data/imgs/favicons/yourfile.png)
- link : url to your service
- appHome : url of apps
- locaton : name of your machine or physical location
- desc : description of service
- type : can be webapp (hard install) or docker or vm (virtaul machine) or redirection
### Config file
Config.yaml is generate by Nofu, you can edit it manualy or via settings page
### Users file
Users.yaml is generate by Nofu, he contain username, password and role (not use for moment).
## Backup and restore
### Backup
All personal data are save in "data" folder. Just backup this dir.
### Restore
Replace the default data direcory by your backup, go to settings pages and check "Reimport images and user files".
## Ressources ## 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/448401/docker"><img alt="docker icon" src="public/assets/icons/docker.svg" width="24"> svgrepo.com (MLP licence)</a>
@ -91,7 +162,7 @@ Open http://127.0.0.1:8189
* <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/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> * <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 :-) And some piece of code from Stack Overflow :-)
## Licence ## Licence