Verwendung
0. SSH in den Server
Verbinde sich als Root mit deinem Server:
ssh root@<SERVER_IP>
Melde dich mit deinem Passwort an.
1. Wechsle zum Anwendungsbenutzer
Alle Paperclip-Vorgänge müssen unter dem dedizierten Benutzer ausgeführt werden:
su - paperclip
Führe Paperclip NICHT als Root aus.
2. Erstmalige Einrichtung (Onboarding-Assistent)
Führe das interaktive Setup aus:
paperclipai onboard
Dadurch wird deine Instanz für die erste Verwendung konfiguriert.
3. Starte Paperclip
Starte die Anwendung:
paperclipai run
Um es nach dem Abmelden am Laufen zu halten, verwende Tools wie tmux
4. Standarddienste
Nach der Ausführung (sofern nicht neu konfiguriert) zeigt das System Folgendes an:
- API-Server →
http://127.0.0.1:3100/api - Gesundheitscheck →
http://127.0.0.1:3100/api/health - Benutzeroberfläche →
http://127.0.0.1:3100
Dies sind die Standardeinstellungen und gelten, sofern du die Bindung, den Port oder die Domäne während der Konfiguration nicht explizit ändern.
5. Nützliche Befehle
# Help / CLI reference
paperclipai --help
# Diagnose issues
paperclipai doctor
# Reconfigure setup
paperclipai configure
# Print environment variables for deployment
paperclipai env
6. Sicherer Zugriff auf die Benutzeroberfläche (SSH-Tunneling)
Führe auf deinem lokalen Computer Folgendes aus:
ssh -L 3100:127.0.0.1:3100 paperclip@<SERVER_IP>
Melde dich mit den auf dem Server gespeicherten Anmeldeinformationen an:
/root/.cloudzy-creds
Navigiere zu http://127.0.0.1:3100 in deinem lokalen Browser, um auf die Paperclip-Benutzeroberfläche zuzugreifen.
Stelle sicher, dass Paperclip auf dem Server ausgeführt wird, andernfalls sind die Benutzeroberfläche und die API nicht zugänglich.
Wichtige Pfade
- Home-Verzeichnis:
/home/paperclip - Konfiguration:
/home/paperclip/.paperclip/instances/default/config.json - Protokolle/Daten:
/home/paperclip/.paperclip/ - NVM-Verzeichnis:
/home/paperclip/.nvm/
Notizen
- Laufen du nicht
paperclipaiBefehle als Root ausführen (immer unter dem ausführen).paperclipBenutzer) - Der
paperclipBenutzeranmeldeinformationen werden sicher gespeichert/root/.cloudzy-creds - du kannst sich auch direkt als anmelden
paperclipBenutzer, der SSH verwendet:ssh paperclip@<SERVER_IP> - Wenn du als Root angemeldet sind, wechsle immer zum Anwendungsbenutzer, bevor du Paperclip-Befehle ausführen:
su - paperclip - Laufen
onboardnur bei Ersteinrichtung - Verwenden
configurespäter für Änderungen