Paperclip

Usage

0. SSH ke server

Hubungkan ke server Anda sebagai root:

ssh root@<SERVER_IP>

Login menggunakan password Anda.

1. Beralih ke pengguna aplikasi

Semua operasi Paperclip harus dijalankan dengan user khusus berikut:

su - paperclip

JANGAN jalankan Paperclip sebagai root.

2. Setup pertama kali (wizard onboarding)

Jalankan setup interaktif:

paperclipai onboard

Ini mengonfigurasi instance Anda untuk pertama kali digunakan.

3. Start Paperclip

Jalankan aplikasi:

paperclipai run

Agar tetap berjalan setelah logout, gunakan tool seperti tmux

4. Default services

Setelah berjalan (kecuali dikonfigurasi ulang), sistem akan mengekspos:

• API server → http://127.0.0.1:3100/api
• Health check → http://127.0.0.1:3100/api/health
• UI → http://127.0.0.1:3100

Ini adalah pengaturan default dan akan berlaku kecuali Anda secara eksplisit mengubah binding, port, atau domain saat konfigurasi.

5. Useful commands

# Help / CLI reference
paperclipai --help

# Diagnose issues
paperclipai doctor

# Reconfigure setup
paperclipai configure

# Print environment variables for deployment
paperclipai env

6. Akses UI secara aman (tunneling SSH)

Dari mesin lokal Anda, jalankan:

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

Login menggunakan kredensial yang tersimpan di server pada:

/root/.cloudzy-creds

Navigate to http://127.0.0.1:3100 di browser lokal Anda untuk mengakses UI Paperclip.

Pastikan Paperclip sudah berjalan di server, jika tidak, UI dan API tidak akan dapat diakses.

Important Paths

• Home directory: /home/paperclip
• Config: /home/paperclip/.paperclip/instances/default/config.json
• Logs/data: /home/paperclip/.paperclip/
• NVM directory: /home/paperclip/.nvm/

Notes

• Do not run paperclipai perintah sebagai root (selalu jalankan di bawah paperclip user)
• The paperclip kredensial pengguna tersimpan dengan aman di /root/.cloudzy-creds
• Anda juga bisa login langsung sebagai paperclip pengguna menggunakan SSH: ssh paperclip@<SERVER_IP>
• Saat login sebagai root, selalu beralih ke pengguna aplikasi sebelum menjalankan perintah Paperclip apa pun: su - paperclip
• Run onboard hanya pada saat pertama kali setup
• Use configure untuk perubahan berikutnya