{"id":27595684,"url":"https://github.com/quexpl/serve","last_synced_at":"2026-02-12T21:30:53.950Z","repository":{"id":278652488,"uuid":"936334992","full_name":"quexpl/serve","owner":"quexpl","description":"Serve is escript to quickly start an HTTP server, with directory index.","archived":false,"fork":false,"pushed_at":"2026-02-05T10:02:10.000Z","size":129,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-05T21:48:03.156Z","etag":null,"topics":["cowboy-webserver","developer-tools","elixir","escript","http-server","static-website-server"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/serve","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quexpl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-20T23:05:33.000Z","updated_at":"2026-02-05T10:05:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"2cf185b9-3bb3-4af4-ba64-e51d1cb49bbc","html_url":"https://github.com/quexpl/serve","commit_stats":null,"previous_names":["quexpl/serve"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/quexpl/serve","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quexpl%2Fserve","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quexpl%2Fserve/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quexpl%2Fserve/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quexpl%2Fserve/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quexpl","download_url":"https://codeload.github.com/quexpl/serve/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quexpl%2Fserve/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29381744,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T20:34:40.886Z","status":"ssl_error","status_checked_at":"2026-02-12T20:23:00.490Z","response_time":55,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cowboy-webserver","developer-tools","elixir","escript","http-server","static-website-server"],"created_at":"2025-04-22T12:16:48.494Z","updated_at":"2026-02-12T21:30:53.934Z","avatar_url":"https://github.com/quexpl.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serve\n\n[![Actions Status](https://github.com/quexpl/serve/workflows/CI/badge.svg)](https://github.com/quexpl/serve/actions?query=workflow%3ACI)\n[![Hex pm](https://img.shields.io/hexpm/v/serve.svg?style=flat)](https://hex.pm/packages/serve)\n[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/serve)\n\n\n**Serve** is escript to quickly start an HTTP server, similar to quick-start solutions available in other languages:\n\n```shell\n$ php -S localhost:8080\n$ ruby -run -e httpd . -p 8080\n$ python3 -m http.server 8080\n```\n\nWith **Serve**, you can quickly start an HTTP server:\n\n```shell\n$ serve /var/www/html\n[info] Serving /var/www/html with Cowboy 2.13.0 at http://127.0.0.1:4444\n```\n\n## Installation\n\nTo install from Hex, run:\n\n    $ mix escript.install hex serve\n\nTo build and install it locally run:\n\n    $ mix install\n\nit's a alias for:\n\n    $ mix do deps.get, escript.build, escript.install\n\n\u003e Note: For convenience, consider adding `~/.mix/escripts` directory to your `$PATH` environment variable.\n\u003e If you are using [asdf](https://github.com/asdf-vm/asdf) Whenever you install a new escript with `mix escript.install` you need to `asdf reshim elixir` in order to create shims for it.\n\nIf you want to uninstall Serve simply run:\n\n    $ mix escript.uninstall serve\n\n## Options\n\n### Comand line options\n\nYou can pass options directly to `serve`\n\n- `-p`, `--port` - Specify the port to listen on (default: `4444`).\n- `-o`, `--open` - Open the browser automatically.\n- `-n`, `--no-index` - Disable directory listing.\n- `-v`, `--version` - Shows Serve version.\n- `-h`, `--help` - Shows Serve usage information.\n\n```shell\n$ serve --port 3000\n```\n\n### Environment variables\n\nServe also supports environment variables for all options. Simply use env with `MIX_SERVE_` prefix.\n\n```shell\n$ MIX_SERVE_PORT=3000 serve\n```\n\nYou can also add exports to yours profile file, for example:\n```\nexport MIX_SERVE_PORT=8000\nexport MIX_SERVE_OPEN=true\nexport MIX_SERVE_NO_INDEX=true\n```\n\n## Arguments\n\nServe accepts one argument: the directory to be served. If no directory is specified, the current working directory is used.\n\n```shell\n$ pwd\n/var/www/html/my_website\n$ serve\n[info] Serving  /var/www/html/my_website with Cowboy 2.13.0 at http://localhost:4444\n```\n\n```shell\n$ mix docs\nGenerating docs...\nView \"html\" docs at \"doc/index.html\"\nView \"epub\" docs at \"doc/serve.epub\"\n$ serve s doc\n[info] Serving  /home/quex/workspace/serve/doc with Cowboy 2.13.0 at http://localhost:4444\n```\n\n## Features\n\n- dark mode\n- directory index\n\n![dark mode](https://github.com/quexpl/serve/blob/main/images/index-dark.jpg?raw=true)\n![directory index](https://github.com/quexpl/serve/blob/main/images/index.jpg?raw=true)\n![not found](https://github.com/quexpl/serve/blob/main/images/404.jpg?raw=true)\n\n## Security\n\nAlthough Serve uses the robust Cowboy HTTP server, it is not intended to be a production-ready web server. It only supports the HTTP protocol and listens on the loopback interface.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquexpl%2Fserve","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquexpl%2Fserve","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquexpl%2Fserve/lists"}