m/umami
1
0
Fork 0
mirror of https://github.com/kremalicious/umami.git synced 2024-12-18 07:13:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

reset readme

Browse Source
This commit is contained in:
Manda Putra 2022-01-08 00:32:56 +07:00
parent 7d9372baa7
commit f10a8224f1
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -18,7 +18,7 @@ A detailed getting started guide can be found at [https://umami.is/docs/](https:
```
git clone https://github.com/mikecao/umami.git
cd umami
yarn
npm install
```
### Create database tables
@ -50,7 +50,6 @@ HASH_SALT=(any random string)
```
The connection url is in the following format:
```
postgresql://username:mypassword@localhost:5432/mydb
@ -61,19 +60,17 @@ The `HASH_SALT` is used to generate unique values for your installation.
### Build the application
For development purpose, you need to build first that is because the application need to prepare language and geo setting.
```bash
yarn build
npm run build
```
### Start the application
```bash
yarn start
npm start
```
By default this will launch the application on `http://localhost:3000`. You will need to either
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.
@ -86,13 +83,11 @@ docker-compose up
```
Alternatively, to pull just the Umami Docker image with PostgreSQL support:
```bash
docker pull ghcr.io/mikecao/umami:postgresql-latest
```
Or with MySQL support:
```bash
docker pull ghcr.io/mikecao/umami:mysql-latest
```
@ -103,8 +98,8 @@ To get the latest features, simply do a pull, install any new dependencies, and
```bash
git pull
yarn
yarn build
npm install
npm run build
```
## License