Paperclip

Uso

0. SSH no servidor

Conecte-se ao seu servidor como root:

ssh root@<SERVER_IP>

Faça login usando sua senha.

1. Alterne para o usuário da aplicação

Todas as operações do Paperclip devem ser executadas com o usuário dedicado:

su - paperclip

NÃO execute o Paperclip como root.

2. Configuração inicial (assistente de instalação)

Execute a configuração interativa:

paperclipai onboard

Isso prepara sua instância para o primeiro uso.

3. Iniciar Paperclip

Inicie a aplicação:

paperclipai run

Para mantê-la ativa após o logout, use ferramentas como tmux

4. Serviços padrão

Quando em execução (salvo reconfiguração), o sistema expõe:

• Servidor API → http://127.0.0.1:3100/api
• Verificação de saúde → http://127.0.0.1:3100/api/health
• Interface do Usuário → http://127.0.0.1:3100

Estas são as configurações padrão e serão aplicadas a menos que você altere explicitamente o binding, a porta ou o domínio durante a configuração.

5. Comandos úteis

# Help / CLI reference
paperclipai --help

# Diagnose issues
paperclipai doctor

# Reconfigure setup
paperclipai configure

# Print environment variables for deployment
paperclipai env

6. Acesse a interface com segurança (tunelamento SSH)

Na sua máquina local, execute:

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

Faça login com as credenciais armazenadas no servidor em:

/root/.cloudzy-creds

Navegue para http://127.0.0.1:3100 no seu navegador local para acessar a interface do Paperclip.

Certifique-se de que o Paperclip está em execução no servidor, caso contrário a interface e o API não estarão acessíveis.

Caminhos Importantes

• Diretório inicial: /home/paperclip
• Configuração: /home/paperclip/.paperclip/instances/default/config.json
• Registos/dados: /home/paperclip/.paperclip/
• Diretório NVM: /home/paperclip/.nvm/

Notas

• Não executar paperclipai comandos como root (execute sempre com o usuário paperclip utilizador)
• O paperclip as credenciais do usuário são armazenadas com segurança em /root/.cloudzy-creds
• Você também pode fazer login diretamente como o usuário paperclip usando SSH: ssh paperclip@<SERVER_IP>
• Quando estiver logado como root, sempre alterne para o usuário da aplicação antes de executar qualquer comando do Paperclip: su - paperclip
• Executar onboard somente na configuração inicial
• Usar configure posteriormente para alterações