mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Fix errors
This commit is contained in:
Plumf
parent
c399634638
commit
3399103b50
5 changed files with 101 additions and 27 deletions
|
|
@ -1,5 +1,74 @@
|
|||
===== Pihole =====
|
||||
# <img src="/images/pihole_logo.png" width="80px" alt="Pi-hole's logo"> Pi-hole
|
||||
|
||||
Homepage: https://pi-hole.net
|
||||
[](https://install-app.yunohost.org/?app=pihole) [](https://dash.yunohost.org/appci/app/pihole)
|
||||
|
||||
**Pi-hole®** Network-wide ad blocking via your own DNS server, with nice Performance And Statistics web page.
|
||||
### Index
|
||||
|
||||
- [Use Pi-Hole as DHCP server](#use-pi-hole-as-server-dhcp)
|
||||
- [Configure Pi-Hole](#configure-pi-hole)
|
||||
- [Configure my router](#configure-my-router)
|
||||
- [Restore Network](#restore-network)
|
||||
- [Useful links] [# Useful links]
|
||||
|
||||
Pi-hole is a network-level ad blocker that acts as a DNS liar and possibly a DHCP3 server for use on a private network. It is designed to be installed on embedded devices with network capabilities, such as the Raspberry Pi, but can be used on other machines running Linux or in virtualized environments.
|
||||
|
||||
## Using Pi-Hole as a DHCP server
|
||||
|
||||
> **Warning, you should be aware that touching your DHCP could break your network.
|
||||
In case your server is inaccessible, you will lose your dns resolution and IP address.
|
||||
Thus, you would lose any connection to the internet and even the connection to your router.**
|
||||
|
||||
> If you encounter this kind of problem, please read the section "How to restore my network".
|
||||
|
||||
### Configuring Pi-hole
|
||||
|
||||
There are 2 ways to configure Pi-hole to be used as your DHCP server.
|
||||
- Either you can choose to use it when you install the application.
|
||||
- Or you can activate the DHCP server afterwards in the "Settings" tab, part "Pi-hole DHCP Server".
|
||||
In this second case, it may be preferable to force the server ip to a static address.
|
||||
|
||||
### Configure my router
|
||||
|
||||
Your router or your ISP's router has a DHCP server enabled by default.
|
||||
If you keep this DHCP, along with Pi-hole's, you will have transparent conflicts between them.
|
||||
The first DHCP server to respond will distribute its own ip and settings.
|
||||
So you need to turn off your router's DHCP server and let Pi-hole manage your network.
|
||||
|
||||
#### Why should I use Pi-hole's DHCP?
|
||||
|
||||
By using Pi-hole's DHCP, you allow Pi-hole to give its dns configuration to each of your clients. This way, every request will be filtered by Pi-hole.
|
||||
|
||||
Another case of using Pi-hole DHCP is if you have hairpinning problems (you can't connect to your server because its ip is your public ip, and your router doesn't allow this).
|
||||
In this case, using Pi-hole's dns will allow you to connect to your server by its local address rather than its public address.
|
||||
|
||||
### Restore the network
|
||||
|
||||
> Oops!
|
||||
Your Pi-hole server has crashed, and you don't have DHCP anymore.
|
||||
Don't panic. We'll get through this.
|
||||
|
||||
Use your favorite device on your desktop computer.
|
||||
And first, get your network interface (usually `eth0`).
|
||||
```bash
|
||||
sudo ifconfig
|
||||
```
|
||||
|
||||
Then change your ip to a static ip.
|
||||
```bash
|
||||
sudo ifconfig eth0 192.168.1.100
|
||||
```
|
||||
|
||||
Now you can connect to your router and reboot its DHCP server to use it again.
|
||||
You can now remove your static ip and get a dynamic ip again.
|
||||
```bash
|
||||
sudo ifconfig eth0 0.0.0 && sudo dhclient eth0
|
||||
```
|
||||
|
||||
> Remember to turn off your router's DHCP if your server is running again.
|
||||
|
||||
## Useful links
|
||||
|
||||
+ Website: [WEBSITE](#)
|
||||
+ Official documentation: [DOCUMENTATION](#)
|
||||
+ Application software repository: [github.com - YunoHost-Apps/pihole](https://github.com/YunoHost-Apps/pihole_ynh)
|
||||
+ Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/pihole/issues](https://github.com/YunoHost-Apps/pihole_ynh/issues)
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# <img src="/images/pihole_logo.png" alt="logo de Pi-hole"> Pi-hole
|
||||
|
||||
[](https://install-app.yunohost.org/?app=pihole)[](https://dash.yunohost.org/appci/app/pihole)  
|
||||
[](https://install-app.yunohost.org/?app=pihole)[](https://dash.yunohost.org/appci/app/pihole)
|
||||
|
||||
- [Utiliser Pi-Hole comme serveur DHCP](#utiliser-pi-Hole-comme-serveur-dhcp)
|
||||
- [Utiliser Pi-Hole comme serveur DHCP](#utiliser-pi-hole-comme-serveur-dhcp)
|
||||
- [Configurer Pi-Hole](#configurer-pi-hole)
|
||||
- [Configurer mon routeur](#configurer-mon-routeur)
|
||||
- [Restaurer le réseau](#restaurer-le-reseau)
|
||||
- [Liens utiles](#quelques-liens-utiles)
|
||||
- [Restaurer le réseau](#restaurer-le-réseau)
|
||||
- [Liens utiles](#liens-utiles)
|
||||
|
||||
Pi-hole est un bloqueur de publicité au niveau du réseau qui agit comme un DNS menteur et éventuellement un serveur DHCP3, destiné à être utilisé sur un réseau privé. Il est conçu pour être installé sur des périphériques intégrés dotés de capacités réseau, tels que le Raspberry Pi, mais il peut être utilisé sur d'autres machines exécutant Linux ou dans des environnements virtualisés.
|
||||
|
||||
|
|
@ -64,7 +64,9 @@ sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0
|
|||
|
||||
> N'oubliez pas d'éteindre le DHCP de votre routeur si votre serveur fonctionne à nouveau.
|
||||
|
||||
## Quelques liens utiles
|
||||
## Liens utiles
|
||||
|
||||
+ Site officiel : [pi-hole.net](https://pi-hole.net)
|
||||
+ Documentation Pi-Hole : [docs.pi-hole.net](https://docs.pi-hole.net/)
|
||||
+ Site web : [pi-hole.net (en)](https://pi-hole.net)
|
||||
+ Documentation officielle : [docs.pi-hole.net (en)](https://docs.pi-hole.net/)
|
||||
+ Dépôt logiciel de l'application : [github.com - YunoHost-Apps/pihole](https://github.com/YunoHost-Apps/pihole_ynh)
|
||||
+ Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/pihole/issues](https://github.com/YunoHost-Apps/pihole_ynh/issues)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
* [General ways of contributing to YunoHost](/contribute)
|
||||
* [Writing documentation](/write_documentation)
|
||||
* [Documentation wrinting guide](doc_writing_guide)
|
||||
* [Documentation wrinting guide](/doc_writing_guide)
|
||||
* [markdown guide](/doc_markdown_guide)
|
||||
* [Propulser son code avec Git & GitHub](/doc_use_git)
|
||||
* [Chat rooms](/chat_rooms)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
* [Liste des façons de contribuer à YunoHost](/contribute)
|
||||
* [Écrire de la documentation](/write_documentation)
|
||||
* [Guide de redaction de la documentation](doc_writing_guide)
|
||||
* [Guide de redaction de la documentation](/doc_writing_guide)
|
||||
* [Guide markdown](/doc_markdown_guide)
|
||||
* [Propulser son code avec Git & GitHub](/doc_use_git)
|
||||
* [Salons de discussion](/chat_rooms)
|
||||
|
|
|
|||
|
|
@ -31,8 +31,8 @@ Pour taper un retour à la ligne sans créer de nouveau paragraphe, il est néce
|
|||
En rédigeant ça :
|
||||
|
||||
```markdown
|
||||
Pour du texte en *italique il faut encadrer par un astérisque`*`*
|
||||
Pour rédiger du **texte en gras par deux astérisques**
|
||||
Pour du texte en *italique il faut encadrer par un astérisque* `*`
|
||||
Pour rédiger du **texte en gras par deux astérisques** `**`
|
||||
On peut aussi ~~barrer le texte~~ en encadrant avec deux tildes `~`
|
||||
```
|
||||
|
||||
|
|
@ -53,11 +53,12 @@ Pour créer un lien vers un site hors de la documentation de YunoHost :
|
|||
s'affichera comme tel :
|
||||
[Texte à afficher](https://lelien.tld)
|
||||
|
||||
C'est identique pour les pages de la documentation, excepté que le lien est interne. Il renvoie au fichier du wiki, sans extension de langgue et de fichier (le `_fr.md`) :
|
||||
C'est identique pour les pages de la documentation, excepté que le lien est interne. Il renvoie au fichier du wiki, sans extension de langue et de fichier (le `_fr.md`) :
|
||||
```markdown
|
||||
[Page du wiki](/write_documentation)
|
||||
```
|
||||
|
||||
Le lien renverra vers la page avec la bonne configuration de langue si la page existe.
|
||||
[Page du wiki](/write_documentation)
|
||||
|
||||
### Créer des ancres
|
||||
|
|
@ -94,7 +95,7 @@ Il est possible de faire un lien avec une image, exemple :
|
|||
```
|
||||
[](/write_documentation)
|
||||
|
||||
L'encart de *texte à afficher en cas d'impossibilité de chargement de l'image* n'est pas obligatoire mais fortement recommandé.
|
||||
L'encart de *texte à afficher en cas d'impossibilité de chargement de l'image* entre les corchets dans le lien de l'image n'est pas obligatoire mais fortement recommandé.
|
||||
|
||||
## Formater une citation
|
||||
|
||||
|
|
@ -129,9 +130,9 @@ Les listes ordonnées peuvent s'incrémenter autant que vous le désirez, il n'e
|
|||
1. liste 3
|
||||
1. Liste 3a
|
||||
1. Liste 3b
|
||||
3. Liste 3b1
|
||||
3. Liste 3b2
|
||||
3. Liste 3b3
|
||||
7. Liste 3b1
|
||||
7. Liste 3b2
|
||||
7. Liste 3b3
|
||||
4. Liste 1
|
||||
4. Liste 2
|
||||
4. liste 3
|
||||
|
|
@ -206,41 +207,43 @@ Pour créer un tableau, il faut utiliser la barre verticale `|` et les tirets `-
|
|||
| **Un tableau** | Une colonne | Une seconde | Autant que l'on veut |
|
||||
|:--------------:|:-----------:|:-----------:|:--------------------:|
|
||||
| Une ligne formatée | | Et du **texte en gras** | Ou en *italique* |
|
||||
| D'autres lignes | | | [Ou un lien]( contributordoc) |
|
||||
| D'autres lignes | | | [Ou un lien](/contributordoc) |
|
||||
```
|
||||
Ce qui afficherait ça :
|
||||
|
||||
| **Un tableau** | Une colonne | Une seconde | Autant que l'on veut |
|
||||
|:--------------:|:-----------:|:-----------:|:--------------------:|
|
||||
| Une ligne formatée | | Et du **texte en gras** | Ou en *italique* |
|
||||
| D'autres lignes | | | [Ou un lien]( contributordoc) |
|
||||
| D'autres lignes | | | [Ou un lien](/contributordoc) |
|
||||
|
||||
## Bloc de codes
|
||||
|
||||
Pour afficher du texte en brut, des `blocs de codes` peuvent être créer en utilisant l'accent grave `Alt Gr + è` :
|
||||
|
||||
````markdown
|
||||
Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl`
|
||||
```markdown
|
||||
Soit inline, par exemple pour mettre en valeur une touche comme 'Ctrl'
|
||||
```
|
||||
|
||||
ou directement en bloc.
|
||||
La seule différence est dans la quantité d'accents graves :
|
||||
Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne
|
||||
|
||||
Ce qui donnera au rendu :
|
||||
|
||||
```
|
||||
'''
|
||||
Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl`
|
||||
|
||||
'''
|
||||
```
|
||||
ou directement en bloc.
|
||||
La seule différence est dans la quantité d'accents graves :
|
||||
Minimum trois accents graves en ouverture et fermeture de bloc et deux accent grave qui encadre le morceau de texte à formater dans une ligne
|
||||
```
|
||||
|
||||
## Liens utiles
|
||||
|
||||
+ La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/)
|
||||
+ Tutoriel Markdown sur [markdowntutorial.com (en)](https://markdowntutorial.com)
|
||||
|
||||
## Aller plus loin <a name ="AllerLoin"></a>
|
||||
## Aller plus loin
|
||||
|
||||
De manière plus général, pour comprendre comment est formaté un texte il suffit juste d'inspecter le document source avec une application note. Ce n'est pas pour autant que le wiki de YunoHost pourra l'exploiter. Il existe bien d'autres possibilités d'utiliser la syntaxe markdown, n'hésitez pas à ajouter des fonctionnalités manquantes. Si vous avez observé des manques et/ou que vous avez des questions, contactez-nous sur [le forum](https://forum.yunohost.org) ou par message directe sur le salon IRC : **#yunohost** sur [irc.freenode.net](https://irc.freenode.net).
|
||||
|
|
|
|||
Loading…
Reference in a new issue