+
+
+
Empowering insights. Preserving privacy.
-A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/) ++ Umami is a simple, fast, privacy-focused alternative to Google Analytics. +
-## Installing from source + + +--- + +## 🚀 Getting Started + +A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/). + +--- + +## 🛠 Installing from Source ### Requirements - A server with Node.js version 16.13 or newer -- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [Postgresql](https://www.postgresql.org/) (minimum v12.14) databases. +- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [PostgreSQL](https://www.postgresql.org/) (minimum v12.14) databases. ### Install Yarn -``` +```bash npm install -g yarn ``` -### Get the source code and install packages +### Get the Source Code and Install Packages -``` +```bash git clone https://github.com/umami-software/umami.git cd umami yarn install ``` -### Configure umami +### Configure Umami -Create an `.env` file with the following +Create an `.env` file with the following: -``` +```bash DATABASE_URL=connection-url ``` -The connection url is in the following format: +The connection URL format: -``` +```bash postgresql://username:mypassword@localhost:5432/mydb - mysql://username:mypassword@localhost:3306/mydb ``` -### Build the application +### Build the Application ```bash yarn build ``` -The build step will also create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**. +*The build step will create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**.* -### Start the application +### Start the Application ```bash yarn start ``` -By default this will launch the application on `http://localhost:3000`. You will need to either -[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server -or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly. +*By default, this will launch the application on `http://localhost:3000`. You will need to either [proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.* -## Installing with Docker +--- -To build the umami container and start up a Postgres database, run: +## 🐳 Installing with Docker + +To build the Umami container and start up a Postgres database, run: ```bash docker compose up -d @@ -81,7 +107,9 @@ Or with MySQL support: docker pull docker.umami.is/umami-software/umami:mysql-latest ``` -## Getting updates +--- + +## 🔄 Getting Updates To get the latest features, simply do a pull, install any new dependencies, and rebuild: @@ -98,7 +126,36 @@ docker compose pull docker compose up --force-recreate ``` -## License +--- -MIT +## 📞 Contact + + +[release-shield]: https://img.shields.io/github/release/umami-software/umami.svg +[releases-url]: https://github.com/umami-software/umami/releases +[license-shield]: https://img.shields.io/github/license/umami-software/umami.svg +[license-url]: https://github.com/umami-software/umami/blob/master/LICENSE +[build-shield]: https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml +[build-url]: https://github.com/umami-software/umami/actions +[github-shield]: https://img.shields.io/badge/GitHub--blue?style=social&logo=github +[github-url]: https://github.com/umami-software/umami +[twitter-shield]: https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter +[twitter-url]: https://twitter.com/umami_software +[linkedin-shield]: https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin +[linkedin-url]: https://linkedin.com/company/umami-software +[discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=discord +[discord-url]: https://discord.com/invite/4dz4zcXYrQ diff --git a/src/assets/logo-white.svg b/src/assets/logo-white.svg new file mode 100644 index 00000000..12a76d34 --- /dev/null +++ b/src/assets/logo-white.svg @@ -0,0 +1,4 @@ +
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+