# 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](https://www.python.org/).
3. **Acesso à Internet**: É necessário para criar o túnel SSH e acessar o servidor.
## Instalação
1. **Instale via pip**:
```bash
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**:
```bash
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:
```bash
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:
```bash
cicotunnel 3306
```
* Expor a porta do MySQL do localhost utilizando um servidor SSH específico:
```bash
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](https://github.com/hugosantoslisboa/cico-tunnel). 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](https://github.com/hugosantoslisboa/cico-tunnel/issues) 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/hugosantoslisboa/cico-tunnel",
"name": "cico-tunnel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Hugo Santos Lisboa",
"author_email": "hugosantoslisboa@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/35/39/7b947f02b1a3b7df782a8f8b81c2d8dedc1e20ee68166dd171158f0d896e/cico_tunnel-1.1.5.tar.gz",
"platform": null,
"description": "# Cico Tunnel\r\n\r\nO **Cicotunnel** \u00e9 uma ferramenta que utiliza SSH para expor portas locais para a internet de forma segura e f\u00e1cil. Com o Cico Tunnel, voc\u00ea pode criar um t\u00fanel SSH para acessar seu servidor local a partir de qualquer lugar.\r\n\r\n## Pr\u00e9-requisitos\r\n\r\nAntes de come\u00e7ar, certifique-se de que voc\u00ea possui:\r\n\r\n1. **Acesso SSH**: Voc\u00ea precisa de um servidor SSH ao qual voc\u00ea tenha acesso e permiss\u00e3o para criar t\u00faneis. \r\n * Voc\u00ea pode usar seu pr\u00f3prio servidor, mas precisar\u00e1:\r\n - Criar um usu\u00e1rio SSH.\r\n - Permitir login sem senha.\r\n - Permitir o forwarding e o gateway.\r\n * Ou voc\u00ea pode usar o servidor fornecido pelo Cico Tunnel para um acesso r\u00e1pido.\r\n \r\n2. **Python**: Certifique-se de que o Python est\u00e1 instalado no seu sistema. Voc\u00ea pode baixar a vers\u00e3o mais recente do Python em [python.org](https://www.python.org/).\r\n\r\n3. **Acesso \u00e0 Internet**: \u00c9 necess\u00e1rio para criar o t\u00fanel SSH e acessar o servidor.\r\n\r\n## Instala\u00e7\u00e3o\r\n\r\n1. **Instale via pip**:\r\n\r\n ```bash\r\n pip install cico-tunnel\r\n ```\r\n\r\n## Uso\r\n\r\nPara usar o Cico Tunnel, siga estas etapas:\r\n\r\n1. **Execute o comando `cicotunnel`, passando a porta local que deseja expor**:\r\n\r\n ```bash\r\n cicotunnel 80\r\n ```\r\n\r\n Isso ir\u00e1 iniciar o Cico Tunnel e criar um t\u00fanel para a porta 80 do seu localhost. \r\n Se voc\u00ea quiser usar um servidor SSH diferente do padr\u00e3o, use a flag `-r` ou `--remote` seguido do endere\u00e7o do seu servidor. Por exemplo:\r\n\r\n ```bash\r\n cicotunnel 80 -r usuario@meu.servidor.com\r\n ```\r\n\r\n2. **Visualize a URL**:\r\n O Cico Tunnel exibir\u00e1 a URL p\u00fablica para o seu servidor local atrav\u00e9s do t\u00fanel SSH no terminal. Use essa URL para acessar seu servidor local de qualquer lugar na internet.\r\n\r\n## Exemplos\r\n\r\n* Expor a porta do MySQL do localhost no cicotunnel:\r\n\r\n ```bash\r\n cicotunnel 3306\r\n ```\r\n\r\n* Expor a porta do MySQL do localhost utilizando um servidor SSH espec\u00edfico:\r\n\r\n ```bash\r\n cicotunnel 3306 -r usuario@meu.servidor.com\r\n ```\r\n\r\n\r\n## Contribuindo\r\n\r\nSinta-se \u00e0 vontade para contribuir com o projeto! Voc\u00ea pode fazer isso de v\u00e1rias maneiras:\r\n\r\n- **Dar Estrelas**: Se voc\u00ea gostou do Cicotunnel e acha que ele \u00e9 \u00fatil, considere dar uma estrela \u2b50 no [reposit\u00f3rio](https://github.com/hugosantoslisboa/cico-tunnel). Isso ajuda a apoiar o projeto e mostra que voc\u00ea aprecia o trabalho!\r\n\r\n- **Relatar Problemas**: Se voc\u00ea encontrar algum problema ou bug, por favor, abra uma [issue](https://github.com/hugosantoslisboa/cico-tunnel/issues) no reposit\u00f3rio.\r\n\r\n- **Enviar Pull Requests**: Se voc\u00ea tem melhorias ou corre\u00e7\u00f5es, envie um pull request para o reposit\u00f3rio.\r\n\r\n- **Feedback**: Qualquer feedback \u00e9 bem-vindo para ajudar a melhorar o Cico Tunnel.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Expose your localhost to the web. Like a Ngrok",
"version": "1.1.5",
"project_urls": {
"Homepage": "https://github.com/hugosantoslisboa/cico-tunnel"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "652d8080bf3706516b826c2e029278b0cbbb950ab961477a8e728d6c10031325",
"md5": "d84fcc0d7e8bc346a73cc159d959aed2",
"sha256": "a5d52353bfba5f340036c5c2f99626c8ff5f1e443c5e7ae5e791e823aa69de8f"
},
"downloads": -1,
"filename": "cico_tunnel-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d84fcc0d7e8bc346a73cc159d959aed2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4101,
"upload_time": "2024-08-28T17:48:25",
"upload_time_iso_8601": "2024-08-28T17:48:25.396561Z",
"url": "https://files.pythonhosted.org/packages/65/2d/8080bf3706516b826c2e029278b0cbbb950ab961477a8e728d6c10031325/cico_tunnel-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35397b947f02b1a3b7df782a8f8b81c2d8dedc1e20ee68166dd171158f0d896e",
"md5": "184fc808a6b015da3c3447cfb6724b3a",
"sha256": "f9094b4ebae1f0b4d71df17a28abd37ab918b94efaa1e5cde305d99e180dc785"
},
"downloads": -1,
"filename": "cico_tunnel-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "184fc808a6b015da3c3447cfb6724b3a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3825,
"upload_time": "2024-08-28T17:48:26",
"upload_time_iso_8601": "2024-08-28T17:48:26.745819Z",
"url": "https://files.pythonhosted.org/packages/35/39/7b947f02b1a3b7df782a8f8b81c2d8dedc1e20ee68166dd171158f0d896e/cico_tunnel-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 17:48:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hugosantoslisboa",
"github_project": "cico-tunnel",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cico-tunnel"
}
JSON
