{"id":28391393,"url":"https://github.com/wearebraid/umami","last_synced_at":"2025-06-25T21:31:49.095Z","repository":{"id":94888344,"uuid":"290243708","full_name":"wearebraid/umami","owner":"wearebraid","description":null,"archived":false,"fork":false,"pushed_at":"2020-08-25T14:53:37.000Z","size":264,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-31T19:34:01.462Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/wearebraid.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}},"created_at":"2020-08-25T14:53:30.000Z","updated_at":"2020-08-25T14:53:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"a3371098-eb93-4d96-95bc-b7d9675ebad3","html_url":"https://github.com/wearebraid/umami","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wearebraid/umami","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearebraid%2Fumami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearebraid%2Fumami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearebraid%2Fumami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearebraid%2Fumami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wearebraid","download_url":"https://codeload.github.com/wearebraid/umami/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearebraid%2Fumami/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261956081,"owners_count":23236010,"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":"2025-05-31T09:11:55.891Z","updated_at":"2025-06-25T21:31:49.084Z","avatar_url":"https://github.com/wearebraid.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# umami\n\nUmami is a simple, fast, website analytics 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 10.13 or newer\n- A database (MySQL or Postgresql)\n\n### Get the source code and install packages\n\n```\ngit clone https://github.com/mikecao/umami.git\ncd umami\nnpm install\n```\n\n### Create database tables\n\nUmami supports [MySQL](https://www.mysql.com/) and [Postgresql](https://www.postgresql.org/).\nCreate a database for your Umami installation and install the tables with the included scripts.\n\nFor MySQL:\n\n```\nmysql -u username -p databasename \u003c sql/schema.mysql.sql\n```\n\nFor Postgresql:\n\n```\npsql -h hostname -U username -d databasename -f sql/schema.postgresql.sql\n```\n\nThis will also create a login account with username **admin** and password **umami**.\n\n### Configure umami\n\nCreate an `.env` file with the following\n\n```\nDATABASE_URL=(connection url)\nHASH_SALT=(any random string)\n```\n\nThe connection url is in the following format:\n```\npostgresql://username:mypassword@localhost:5432/mydb\n\nmysql://username:mypassword@localhost:3306/mydb\n```\n\nThe `HASH_SALT` is used to generate unique values for your installation.\n\n### Build the application\n\n```\nnpm run build\n```\n\n### Start the application\n\n```\nnpm 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```\ndocker-compose up\n```\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwearebraid%2Fumami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwearebraid%2Fumami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwearebraid%2Fumami/lists"}