📖 Guide uslink

← Accueil

1. Prérequis

Il te faut :

Sur Android (Termux)

pkg install nodejs

Sur Debian / Ubuntu

sudo apt install nodejs npm

VĂ©rifier l'installation

node -v
# Doit afficher v18.x ou plus

npm -v
# Doit afficher 9.x ou plus

2. Installation de uslink

Installer globalement

npm install -g @adnimicorp/uslink

VĂ©rifier l'installation

uslink --version
# → 0.5.x

uslink doctor
# → Diagnostic complet

Initialiser

uslink init

Ça crĂ©e un dossier ~/.uslink/ avec :

Et un nodeId unique t'est attribué. Note-le :

uslink nodeId
# → 5cf7dc74be1b5269 (exemple)

3. Créer ton premier site

Structure minimale

mkdir -p ~/mon-site

Écrire la page d'accueil

cat > ~/mon-site/index.hrl << 'HRL_EOF'
<page title="Mon site">
  <body>
    <h1>Bienvenue sur mon site Spider</h1>
    <p>Mon premier site décentralisé.</p>
    <link usl="/about">À propos</link>
  </body>
</page>
HRL_EOF

Ajouter une page "À propos"

cat > ~/mon-site/about.hrl << 'HRL_EOF'
<page title="À propos">
  <body>
    <h1>À propos</h1>
    <p>Je suis un nƓud Spider.</p>
    <link usl="/">← Retour</link>
  </body>
</page>
HRL_EOF

4. DĂ©ploiement

DĂ©clarer le site

uslink site add mon-site ~/mon-site --default

Lancer le daemon

uslink start

VĂ©rifier

uslink status

Tu dois voir :

✅ uslink tourne
   nodeId    : 5cf7dc74be1b5269
   VIP       : 10.147.149.121
   Sites     : 1
     ★ mon-site (2 fichiers)

Tester en local

curl -s http://127.0.0.1:8080/site/mon-site/ | head -20

5. Partager son site

Obtenir ton URL Spider

uslink share

Ça affiche :

Sur le mĂȘme Wi-Fi

Tes amis n'ont rien Ă  faire. Ils ouvrent SpiderBrowser, tapent ton URL, et c'est en ligne.

Pour Internet

Enregistre ton nom dans le relais public :

curl -X POST https://sp.adnimi.com/api/register \
  -H "Content-Type: application/json" \
  -d '{"name":"monsite","nodeId":"<ton-nodeId>","host":"<ton-ip-publique>","port":7777}'

Ton site devient accessible sur https://monsite.sp.adnimi.com/.

6. Rendre accessible depuis Internet

Par défaut, ton site n'est accessible qu'en LAN. Pour qu'il soit joignable depuis partout, tu as 3 options :

Option A — VPS avec IP publique

Si tu as un VPS, lance uslink dessus. Simple et efficace.

Option B — Tunnel Cloudflare

cloudflared tunnel --url http://localhost:7777

Ça te donne une URL publique temporaire.

Option C — Port forwarding sur ta box

  1. Connecte-toi Ă  ta box Internet
  2. Redirige le port externe 7777 vers ton appareil
  3. Note ton IP publique : curl ifconfig.me
  4. Enregistre ton nom sur le relais

7. Rejoindre le réseau public

Le relais sp.adnimi.com est un annuaire public. S'y enregistrer rend ton site accessible Ă  tous.

S'enregistrer

curl -X POST https://sp.adnimi.com/api/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "monnom",
    "nodeId": "'$(uslink nodeId)'",
    "host": "'$(curl -s ifconfig.me)'",
    "port": 7777
  }'

VĂ©rifier

curl -s https://sp.adnimi.com/api/list

Tester ton site public

curl -s https://monnom.sp.adnimi.com/

Ou dans Chrome : https://monnom.sp.adnimi.com/

Se désinscrire

curl -X DELETE "https://sp.adnimi.com/api/unregister?name=monnom&nodeId=$(uslink nodeId)"

8. Utilisation avancée

Routes personnalisées

Mapper un chemin à un dossier différent :

uslink site route mon-site /blog ~/mon-blog

Multi-sites

uslink site add blog ~/mon-blog
uslink site add shop ~/ma-boutique
uslink site list

Changer le site par défaut

uslink site default blog

Voir les logs

uslink logs -f

Diagnostic

uslink doctor