Skip to main content

Expose your localhost to the web. Like a Ngrok

Project description

Cico Tunnel

O Cicotunnel é uma ferramenta que utiliza SSH para expor portas locais para a internet de forma segura e fácil. Com o Cico Tunnel, você pode criar um túnel SSH para acessar seu servidor local a partir de qualquer lugar.

Pré-requisitos

Antes de começar, certifique-se de que você possui:

  1. Acesso SSH: Você precisa de um servidor SSH ao qual você tenha acesso e permissão para criar túneis.

    • Você pode usar seu próprio servidor, mas precisará:
      • Criar um usuário SSH.
      • Permitir login sem senha.
      • Permitir o forwarding e o gateway.
    • Ou você pode usar o servidor fornecido pelo Cico Tunnel para um acesso rápido.
  2. Python: Certifique-se de que o Python está instalado no seu sistema. Você pode baixar a versão mais recente do Python em python.org.

  3. Acesso à Internet: É necessário para criar o túnel SSH e acessar o servidor.

Instalação

  1. Instale via pip:

    pip install cico-tunnel
    

Uso

Para usar o Cico Tunnel, siga estas etapas:

  1. Execute o comando cicotunnel, passando a porta local que deseja expor:

    cicotunnel 80
    

    Isso irá iniciar o Cico Tunnel e criar um túnel para a porta 80 do seu localhost. Se você quiser usar um servidor SSH diferente do padrão, use a flag -r ou --remote seguido do endereço do seu servidor. Por exemplo:

    cicotunnel 80 -r usuario@meu.servidor.com
    
  2. Visualize a URL: O Cico Tunnel exibirá a URL pública para o seu servidor local através do túnel SSH no terminal. Use essa URL para acessar seu servidor local de qualquer lugar na internet.

Exemplos

  • Expor a porta do MySQL do localhost no cicotunnel:

    cicotunnel 3306
    
  • Expor a porta do MySQL do localhost utilizando um servidor SSH específico:

    cicotunnel 3306 -r usuario@meu.servidor.com
    

Contribuindo

Sinta-se à vontade para contribuir com o projeto! Você pode fazer isso de várias maneiras:

  • Dar Estrelas: Se você gostou do Cicotunnel e acha que ele é útil, considere dar uma estrela ⭐ no repositório. Isso ajuda a apoiar o projeto e mostra que você aprecia o trabalho!

  • Relatar Problemas: Se você encontrar algum problema ou bug, por favor, abra uma issue no repositório.

  • Enviar Pull Requests: Se você tem melhorias ou correções, envie um pull request para o repositório.

  • Feedback: Qualquer feedback é bem-vindo para ajudar a melhorar o Cico Tunnel.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cico_tunnel-1.1.5.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

cico_tunnel-1.1.5-py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page