Paperclip

Utilisation

0. SSH dans le serveur

Connectez-vous à votre serveur en tant que root :

ssh root@<SERVER_IP>

Connectez-vous avec votre mot de passe.

1. Basculer vers l'utilisateur de l'application

Toutes les opérations Paperclip doivent s'exécuter sous l'utilisateur dédié :

su - paperclip

Ne lancez PAS Paperclip en tant que root.

2. Configuration initiale (assistant d'installation)

Lancez la configuration interactive :

paperclipai onboard

Cela prépare votre instance pour la première utilisation.

3. Démarrer Paperclip

Lancez l'application :

paperclipai run

Pour maintenir l'application active après déconnexion, utilisez des outils comme tmux

4. Services par défaut

Une fois démarré (sauf reconfiguration), le système expose :

• Serveur API → http://127.0.0.1:3100/api
• Vérification de santé → http://127.0.0.1:3100/api/health
• Interface → http://127.0.0.1:3100

Ce sont les paramètres par défaut, qui s'appliquent sauf si vous modifiez explicitement le binding, le port ou le domaine lors de la configuration.

5. Commandes utiles

# Help / CLI reference
paperclipai --help

# Diagnose issues
paperclipai doctor

# Reconfigure setup
paperclipai configure

# Print environment variables for deployment
paperclipai env

6. Accéder à l'interface de façon sécurisée (tunneling SSH)

Depuis votre machine locale, exécutez :

ssh -L 3100:127.0.0.1:3100 paperclip@<SERVER_IP>

Connectez-vous avec les identifiants stockés sur le serveur à l'adresse :

/root/.cloudzy-creds

Accédez à http://127.0.0.1:3100 dans votre navigateur local pour accéder à l'interface Paperclip.

Vérifiez que Paperclip est en cours d'exécution sur le serveur, sinon l'interface et API ne seront pas accessibles.

Chemins importants

• Répertoire personnel : /home/paperclip
• Configuration : /home/paperclip/.paperclip/instances/default/config.json
• Journaux/données : /home/paperclip/.paperclip/
• Répertoire NVM : /home/paperclip/.nvm/

Remarques

• Ne pas exécuter paperclipai de commandes en tant que root (toujours exécuter sous l'utilisateur paperclip )
• La paperclip Les identifiants de l'utilisateur sont stockés de façon sécurisée dans /root/.cloudzy-creds
• Vous pouvez aussi vous connecter directement en tant qu'utilisateur paperclip via SSH : ssh paperclip@<SERVER_IP>
• Lorsque vous êtes connecté en tant que root, passez toujours à l'utilisateur de l'application avant d'exécuter des commandes Paperclip : su - paperclip
• Exécutez onboard uniquement lors de la première installation
• Utilisez configure ensuite pour les modifications