Skip to content
salesHgabrielPublic

About

A project inspired by Valet And laragon

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Dot Valet

CI Release

Aplicativo desktop (Avalonia, multiplataforma) que faz pelo ASP.NET Core o que o Laravel Valet (macOS), o valet-linux e o Laragon (Windows) fazem pelo PHP: cada projeto ganha um domínio .test, com link clicável, HTTPS local opcional e integração com o launchSettings.json.

Funciona com projetos .NET Core 2.x, 3.x, .NET 5, 6, 7, 8, 9, 10 e seguintes.

Dot Valet — lista de sites e detalhes do site

Download

Baixe a versão mais recente em Releases:

Sistema Arquivo
Windows (x64 / ARM64) DotValet-<versão>-win-x64.zip / win-arm64.zip
macOS (Apple Silicon / Intel) DotValet-<versão>-osx-arm64.zip / osx-x64.zip (contém Dot Valet.app)
Linux (x64 / ARM64) DotValet-<versão>-linux-x64.tar.gz / linux-arm64.tar.gz

Os executáveis são self-contained: não é preciso ter o .NET instalado para abrir o Dot Valet (para rodar seus projetos, sim). No macOS o app não é notarizado — na primeira vez use botão direito → Abrir ou xattr -dr com.apple.quarantine "/Applications/Dot Valet.app". No Linux, extraia o .tar.gz e rode ./install.sh para instalar em ~/.local/bin com atalho e ícone no menu de aplicativos (./install.sh --uninstall remove).

Ícones

O ícone vem de tools/icons/icon.svg (e icon-macos.svg, com a margem padrão do macOS). Depois de editar, rode tools/icons/generate.sh (requer rsvg-convert; o .icns só é gerado no macOS):

Plataforma Arquivo Uso
Windows src/DotValet/Assets/icon.ico ícone do .exe (ApplicationIcon) e da janela
macOS packaging/macos/DotValet.icns ícone do Dot Valet.app (Dock, Finder, Launchpad)
Linux packaging/linux/dotvalet.png + dotvalet.desktop menu de aplicativos, via install.sh

Screenshots

Apps de exemplo rodando em domínios .test

Os três projetos de samples/ servidos pelo Dot Valet ao mesmo tempo, cada um em um modo:

http://loja.test — modo proxy http://painel.test:5172 — modo direto https://blog.test — HTTPS com CA local
Loja em http://loja.test Painel em http://painel.test:5172 Blog em https://blog.test
.NET 8, porta interna alocada automaticamente .NET 9, Kestrel escutando na porta do domínio .NET 10, proxy com certificado por domínio (SNI)

Aplicativo

Site com HTTPS Aba Ambiente
Site com HTTPS e perfil do launchSettings.json Aba Ambiente: plataforma, proxy, TLD, certificados e DNS

Como funciona

Peça Laravel Valet Dot Valet
DNS dnsmasq + /etc/resolver/test arquivo hosts (padrão, todas as plataformas) ou dnsmasq (macOS/Linux)
Servidor nginx → PHP-FPM proxy reverso embutido (Kestrel + YARP) → Kestrel do seu app
valet link + Pasta do projeto / + .csproj
valet park Estacionar pasta (cada subpasta com projeto web vira subpasta.test)
valet secure HTTPS no proxy (CA local + certificado por domínio via SNI)
valet share Compartilhar (túnel do ngrok, com domínio fixo e perfil no launchSettings.json)

A plataforma é detectada automaticamente e a estratégia exibida na aba Ambiente.

Dois modos de domínio

  • app ou app.test — modo proxy. O app escuta em http://localhost:51xx (porta alocada automaticamente) e o proxy do Dot Valet publica http://app.test (ou https://app.test).
  • app2.test:5172 — modo direto. O navegador abre http://app2.test:5172; o hosts aponta app2.test para 127.0.0.1 e o Kestrel escuta em http://localhost:5172 — só nesta máquina (escutar no domínio faria o Kestrel abrir a porta em todas as interfaces, expondo o app na rede). O proxy também atende http://app2.test como bônus.

launchSettings.json

Com a opção Incluir a URL no launchSettings.json, o Dot Valet cria (ou atualiza) um perfil — por padrão DotValet — como primeiro perfil do arquivo, então dotnet run, Visual Studio, Rider e VS Code já sobem o app no domínio:

"DotValet": {
  "commandName": "Project",
  "dotnetRunMessages": true,
  "launchBrowser": true,
  "launchUrl": "http://app2.test:5172",
  "applicationUrl": "http://localhost:5172",
  "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" }
}
  • Adicionar também ao applicationUrl dos perfis existentes acrescenta a URL aos perfis Project que já existem (ex.: http, https).
  • Ao trocar domínio/porta/nome do perfil, a entrada anterior é removida; ao remover o site, tudo que o Dot Valet escreveu é desfeito.
  • Na primeira alteração é criado launchSettings.json.dotvalet.bak (comentários do JSON não são preservados).

Executar pelo Dot Valet

▶ Iniciar roda dotnet run --no-launch-profile (ou dotnet watch run) com ASPNETCORE_URLS apontando para a URL do site — funciona igual em todas as versões a partir do ASP.NET Core 2.x — e mostra o log na tela. O app avisa se o runtime ASP.NET Core da versão do projeto não estiver instalado.

Compartilhar com o ngrok (valet share)

O card Compartilhar (ngrok) de cada site publica o app na internet por um túnel do ngrok:

  1. Instale o ngrok (download, brew install ngrok, winget install ngrok.ngrok ou snap install ngrok).
  2. Na aba Ambiente, cole o authtoken da sua conta e clique em Salvar token. Sem token salvo, vale o que estiver configurado com ngrok config add-authtoken.
  3. No site, informe o Domínio do ngrok — o domínio fixo da sua conta (o plano gratuito tem um, em dashboard.ngrok.com/domains), ex.: meu-app.ngrok-free.app. Vazio = URL aleatória a cada vez.
  4. Inicie o site e clique em Compartilhar: a URL pública aparece no card, com botão para copiar.

O Dot Valet roda ngrok http http://127.0.0.1:<porta do app> --url https://<domínio> (em agentes antigos, --domain), então funciona nos modos proxy e direto. Antes de abrir o túnel ele testa 127.0.0.1 e [::1] e usa o endereço em que o app responde — com localhost o ngrok pode tentar só o IPv6 e o visitante vê ERR_NGROK_8012 (connection refused). Esse erro também aparece quando o site não está rodando: inicie-o (▶ Iniciar) ou, rodando pela IDE, use o perfil do Dot Valet (mesma porta). O ngrok entrega HTTPS e envia X-Forwarded-Proto: use UseForwardedHeaders se o app gera URLs absolutas (como os exemplos). No plano gratuito só um agente fica conectado por vez.

Com Criar o perfil "DotValet-ngrok" no launchSettings.json, ao salvar o site é criado um segundo perfil (depois do principal) que abre o navegador na URL do ngrok:

"DotValet-ngrok": {
  "commandName": "Project",
  "launchBrowser": true,
  "launchUrl": "https://meu-app.ngrok-free.app",
  "applicationUrl": "http://localhost:5172"
}

O applicationUrl continua local — o Kestrel não escuta no domínio do ngrok; o tráfego chega pelo túnel. Desmarcar a opção ou remover o site apaga o perfil. O authtoken fica no config.json (permissão 600 no macOS/Linux) e vai para o ngrok pela variável NGROK_AUTHTOKEN, sem aparecer na lista de processos.

Requisitos

  • .NET SDK 8 ou superior para rodar o Dot Valet (o projeto alvo pode usar qualquer versão suportada, desde que o runtime correspondente esteja instalado).
  • Permissão de administrador quando o arquivo hosts ou o DNS precisa ser alterado (macOS: diálogo de senha; Linux: pkexec; Windows: UAC).

Rodando

dotnet run --project src/DotValet
dotnet test

Publicação de um executável:

dotnet publish src/DotValet -c Release -r osx-arm64 --self-contained   # ou win-x64, linux-x64

Apps de exemplo

samples/ tem três minimal APIs (Loja .NET 8, Painel .NET 9, Blog .NET 10) que mostram na página o endereço pelo qual foram abertas. Vincule a pasta de cada uma com + Pasta do projeto para testar os modos proxy, direto e HTTPS. Elas usam UseForwardedHeaders para enxergar o https original que chega do proxy em X-Forwarded-Proto — faça o mesmo nos seus projetos se eles geram URLs absolutas.

Atualizando os screenshots

dotnet run --project tools/DotValet.Screenshots

Sobe os exemplos pelo próprio Dot Valet (config, CA e hosts num diretório temporário — o sistema não é alterado), renderiza a janela sem abri-la (Avalonia headless) e fotografa os sites com o Chrome headless, que resolve *.test para 127.0.0.1 via --host-resolver-rules. Precisa do Chrome (ou CHROME_PATH), dos SDKs .NET 8/9/10 e das portas 80/443 livres. As imagens vão para docs/screenshots/.

CI e releases (GitHub Actions)

  • ci.yml — a cada push/PR compila e roda dotnet test no Ubuntu, macOS e Windows, além de compilar os exemplos e a ferramenta de screenshots.
  • release.yml — ao enviar uma tag v* roda os testes, publica executáveis self-contained (single-file) para win-x64, win-arm64, osx-arm64, osx-x64 (empacotados como Dot Valet.app com assinatura ad-hoc), linux-x64 e linux-arm64, e cria a release com os arquivos e SHA256SUMS.txt. Tags com - (ex.: v0.2.0-beta.1) viram pré-release.
git tag v0.1.0
git push origin v0.1.0

Também dá para rodar manualmente (Actions → Release → Run workflow): gera os artefatos sem criar release.

Observações por plataforma

  • macOS: portas 80/443 funcionam sem root — o macOS só permite isso em endereço curinga, então nesse caso o proxy escuta em todas as interfaces e derruba qualquer conexão que não venha da própria máquina. Para wildcard *.test, use Instalar/configurar dnsmasq (Homebrew), como o Valet. Se o Laravel Valet estiver instalado, o nginx dele ocupa 80/443: o Dot Valet detecta e avisa; pare-o (valet stop) ou mude as portas do proxy.
  • Laravel Valet instalado: o nginx dele ocupa 127.0.0.1:80/443 e o dnsmasq dele responde por *.test. Para não gerar conflito, o Dot Valet recomenda (aba Ambiente) parar o Valet enquanto usa o Dot Valet (valet stop, botão Parar o Valet; valet start para voltar) ou desinstalá-lo se não usa mais PHP (valet uninstall). Se precisar dos dois, marque Integrar com o Valet: cada site vira um valet proxy app.test http://localhost:51xx (com --secure nos sites HTTPS), aplicado com uma única senha e desfeito ao remover o site ou desligar a opção.
  • Linux: portas < 1024 exigem root; o padrão é 8080/8443. Para usar 80/443: sudo sysctl -w net.ipv4.ip_unprivileged_port_start=80. O dnsmasq usa o plugin do NetworkManager (mesma abordagem do valet-linux).
  • Windows: usa o arquivo hosts (como o Laragon). IIS/Skype/etc. podem ocupar a porta 80.
  • HTTPS: clique em Criar e confiar na CA local. O Firefox usa repositório próprio de certificados.

Dados

Tudo fica em ~/.dotvalet/ (config.json, certs/ e backups/).

Backup do arquivo hosts

Com Fazer backup do hosts antes de cada alteração (ligado por padrão, aba Ambiente), antes de qualquer mudança no hosts o Dot Valet grava em ~/.dotvalet/backups/:

  • hosts.principal.bak — o hosts como estava antes da primeira alteração; criado uma vez e nunca sobrescrito.
  • hosts.ultimo.bak — o estado imediatamente anterior à alteração mais recente; o anterior é apagado e substituído a cada mudança.

Os botões Restaurar último backup / Restaurar backup principal devolvem o hosts a esses estados (a restauração também gera um novo "último", então dá para desfazê-la). Se o backup falhar, o hosts não é alterado. As variáveis DOTVALET_HOME e DOTVALET_HOSTS_FILE permitem usar outro diretório/arquivo hosts (útil para testes).

Estrutura

src/DotValet/
  Models/        Site, AppConfig
  Services/      DomainParser, SiteEndpoints, ProjectInspector, LaunchSettingsService,
                 HostsFileService, DnsmasqService, CertificateService, ProxyServer,
                 SiteRunner, NgrokService, DotnetEnvironment, Elevation, PlatformInfo, ConfigStore
  ViewModels/    MainViewModel, SiteViewModel
  Views/         MainWindow
tests/DotValet.Tests/
samples/         Loja, Painel, Blog (apps de exemplo)
tools/DotValet.Screenshots/   gera docs/screenshots/
.github/workflows/            ci.yml, release.yml
packaging/       ícone do macOS (.icns), atalho/ícone/instalador do Linux
tools/icons/     icon.svg e generate.sh

About

A project inspired by Valet And laragon

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages