{"id":19808140,"url":"https://github.com/firefox-devtools/profiler-server","last_synced_at":"2025-05-01T07:32:06.663Z","repository":{"id":35410438,"uuid":"210869785","full_name":"firefox-devtools/profiler-server","owner":"firefox-devtools","description":"Firefox Profiler server and data storage infrastructure ","archived":false,"fork":false,"pushed_at":"2025-04-28T09:29:20.000Z","size":3482,"stargazers_count":20,"open_issues_count":7,"forks_count":12,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-28T10:40:05.905Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/firefox-devtools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2019-09-25T14:47:00.000Z","updated_at":"2025-04-28T09:29:23.000Z","dependencies_parsed_at":"2023-01-16T22:28:01.542Z","dependency_job_id":"420f7c59-b8f6-4f14-b4c0-094d570690b5","html_url":"https://github.com/firefox-devtools/profiler-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefox-devtools%2Fprofiler-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefox-devtools%2Fprofiler-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefox-devtools%2Fprofiler-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefox-devtools%2Fprofiler-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/firefox-devtools","download_url":"https://codeload.github.com/firefox-devtools/profiler-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251840349,"owners_count":21652323,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-12T09:13:06.653Z","updated_at":"2025-05-01T07:32:06.345Z","avatar_url":"https://github.com/firefox-devtools.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Firefox profiler server\n\n[![Matrix][matrix-badge]][matrix]\n\nWelcome to the repository for the Firefox profiler server! This server\nimplements some APIs needed by the profiler UI.\n\nHere are some links to know more:\n\n- The [Firefox Profiler]\n- The [Profiler repository]\n\n## APIs\n\nThe APIs are documented in [API.md](./API.md).\n\n## Develop and running the server locally\n\n### Install the local tooling\n\nYou will need a recent enough version of [Yarn v1](http://classic.yarnpkg.com/),\nversion 1.10 is known to work correctly.\nYou can install it into your home directory on Linux and probably OS X with:\n\n```bash\ncd /tmp\nwget https://yarnpkg.com/install.sh\nchmod a+x install.sh\n./install.sh\n```\n\nor [follow the instructions specific to your OS on Yarn's website](https://classic.yarnpkg.com/en/docs/install).\n\n### Download the profiler code and install its dependencies\n\nTo download and prepare the Firefox Profiler server run:\n\n```bash\ngit clone git@github.com:firefox-devtools/profiler-server.git\ncd profiler-server\nyarn install\n```\n\n#### For Apple M1 chips\n\nThere is an optional dependency that doesn't support M1 chips. Run `yarn install --ignore-optional` instead to skip installing it.\n\n### Configure the server\n\nThen you'll need to configure the server. We use environment variables for this,\nand the convention of a `.env` file. Conveniently we provide a file\n[.env.example](.env.example) that you can first copy to `.env` then edit\nfollowing the comments inside the file.\n\nNote that the profiler server uses 2 external services:\n[Google Cloud Storage](https://cloud.google.com/storage/) and\n[Bitly](https://bitly.com/) and you'll need accounts to use the server's\nendpoints that need them. Both of them provide free accounts. The documentation\nin [docs-developer/google-storage.md](docs-developer/google-storage.md) explains\nfurther how to configure Google Cloud Storage.\n\n### Run the server\n\nLastly you can run the server with:\n\n```bash\nyarn start\n```\n\nThis will start the server on port 5252.\n\n## Build or pull a docker image\n\nWe provide a Dockerfile, the very same one we use to build our official docker\nimage. Find more [in the dedicated documentation](docs-developer/docker.md).\n\nAlso the images we use for production [are public](https://hub.docker.com/r/mozilla/profiler-server/tags),\nyou can pull latest versions with:\n\n- for master: `docker pull mozilla/profiler-server:master-latest`\n- for production: `docker pull mozilla/profiler-server:production-latest`\n\nAgain, look the [dedicated documentation](docs-developer/docker.md) to know more.\n\n## Discussion\n\nSay hello on Matrix in the [_Firefox Profiler_ channel (_#profiler:mozilla.org_)][matrix].\n\n## License\n\n[MPL v2](./LICENSE)\n\n[matrix]: https://chat.mozilla.org/#/room/#profiler:mozilla.org\n\n\u003c!-- chat.mozilla.org's \"real\" server is mozilla.modular.im. --\u003e\n\n[matrix-badge]: https://img.shields.io/matrix/profiler:mozilla.org?server_fqdn=mozilla.modular.im\u0026label=matrix\n[Firefox Profiler]: https://profiler.firefox.com/\n[Profiler repository]: https://github.com/firefox-devtools/profiler/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirefox-devtools%2Fprofiler-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffirefox-devtools%2Fprofiler-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirefox-devtools%2Fprofiler-server/lists"}