{"id":22683256,"url":"https://github.com/mtchavez/umami","last_synced_at":"2025-03-29T14:27:56.084Z","repository":{"id":143221554,"uuid":"614059212","full_name":"mtchavez/umami","owner":"mtchavez","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-14T14:27:40.000Z","size":11788,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-04T15:32:38.688Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mtchavez.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}},"created_at":"2023-03-14T20:07:02.000Z","updated_at":"2024-01-14T13:50:41.000Z","dependencies_parsed_at":"2024-12-09T21:21:34.557Z","dependency_job_id":null,"html_url":"https://github.com/mtchavez/umami","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/mtchavez%2Fumami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtchavez%2Fumami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtchavez%2Fumami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtchavez%2Fumami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mtchavez","download_url":"https://codeload.github.com/mtchavez/umami/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246195621,"owners_count":20738909,"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-12-09T21:11:23.923Z","updated_at":"2025-03-29T14:27:56.061Z","avatar_url":"https://github.com/mtchavez.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# umami\n\nUmami is a simple, fast, privacy-focused alternative to Google Analytics.\n\n## Getting started\n\nA detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/)\n\n## Installing from source\n\n### Requirements\n\n- A server with Node.js version 16.13 or newer\n- A database. Umami supports [MySQL](https://www.mysql.com/) and [Postgresql](https://www.postgresql.org/) databases.\n\n### Install Yarn\n\n```\nnpm install -g yarn\n```\n\n### Get the source code and install packages\n\n```\ngit clone https://github.com/umami-software/umami.git\ncd umami\nyarn install\n```\n\n### Configure umami\n\nCreate an `.env` file with the following\n\n```\nDATABASE_URL=connection-url\n```\n\nThe connection url is in the following format:\n\n```\npostgresql://username:mypassword@localhost:5432/mydb\n\nmysql://username:mypassword@localhost:3306/mydb\n```\n\n### Build the application\n\n```bash\nyarn build\n```\n\nThe build step will also create tables in your database if you ae installing for the first time. It will also create a login user with username **admin** and password **umami**.\n\n### Start the application\n\n```bash\nyarn start\n```\n\nBy default this will launch the application on `http://localhost:3000`. You will need to either\n[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server\nor change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.\n\n## Installing with Docker\n\nTo build the umami container and start up a Postgres database, run:\n\n```bash\ndocker compose up -d\n```\n\nAlternatively, to pull just the Umami Docker image with PostgreSQL support:\n\n```bash\ndocker pull ghcr.io/umami-software/umami:postgresql-latest\n```\n\nOr with MySQL support:\n\n```bash\ndocker pull ghcr.io/umami-software/umami:mysql-latest\n```\n\n## Getting updates\n\nTo get the latest features, simply do a pull, install any new dependencies, and rebuild:\n\n```bash\ngit pull\nyarn install\nyarn build\n```\n\nTo update the Docker image, simply pull the new images and rebuild:\n\n```bash\ndocker compose pull\ndocker compose up --force-recreate\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtchavez%2Fumami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmtchavez%2Fumami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtchavez%2Fumami/lists"}