mirror of
https://github.com/plausible/analytics.git
synced 2024-11-22 18:52:38 +03:00
Update techincal documentation
This commit is contained in:
Uku Taht
parent
e4385b679b
commit
97d8a9fe00
52
HOSTING.md
52
HOSTING.md
@ -1,14 +1,14 @@
|
||||
# Plausible Analytics
|
||||
Self-hosting is possible based on the docker images and are automatically pushed into [Gitlab hosted docker](registry.gitlab.com/tckb-public/plausible) registry for all commits on `master` branch.
|
||||
All `master-*` tags are considered to be stable and are persisted. Any other tag in the registry is considered to be for development purposes and/or unstable and are auto-deleted after a week.
|
||||
|
||||
Self-hosting is possible based on the docker images and are automatically pushed into [Dockerhub](https://hub.docker.com/r/plausible/analytics) registry for all commits on `master` branch. At the moment, `latest` is the only tag on DockerHub as we haven't reached a stable
|
||||
release of self-hosted Plausible yet.
|
||||
|
||||
### Building Docker image
|
||||
Besides the GitlabCI, one can build docker image from [Dockerfile](./Dockerfile).
|
||||
Besides the DockerHub registry, one can build docker image from [Dockerfile](./Dockerfile).
|
||||
|
||||
#### Up and Running
|
||||
The repo supplies with a [Docker Compose](./docker-compose.yml) file, this serves as a sample for running Plausible with Docker.
|
||||
In this sample, the db migration is done by default on startup, so you need to clean the data up every time you run:
|
||||
The repo supplies with a [Docker Compose](./docker-compose.yml) file, this serves as a sample for running Plausible with Docker.
|
||||
In this sample, the db migration is done by default on startup, so you need to clean the data up every time you run:
|
||||
|
||||
First run
|
||||
```bash
|
||||
@ -23,18 +23,18 @@ $ docker-compose up
|
||||
```
|
||||
|
||||
### Non-docker building
|
||||
It is possible to create a release artifact by running a release.
|
||||
It is possible to create a release artifact by running a release.
|
||||
|
||||
```elixir
|
||||
MIX_ENV=prod mix release plausible
|
||||
```
|
||||
the release will create the pre-packed artifact at `_build/prod/rel/plausible/bin/plausible`, the release will also create a tarball at `_build/prod/` for convenience.
|
||||
the release will create the pre-packed artifact at `_build/prod/rel/plausible/bin/plausible`, the release will also create a tarball at `_build/prod/` for convenience.
|
||||
|
||||
Note, that you have to feed in the related environment variables (see below `Environment Variables`)
|
||||
|
||||
## Database Migration
|
||||
On the initial setup, a migration step is necessary to create database and table schemas needed for initial bootup.
|
||||
Normally, this done by mix aliases like `ecto.setup` defined in the `mix.exs`. As this not available in "released" artifact, [`plausible_migration.ex`](./lib/plausible_migration.ex) facilitates this process.
|
||||
On the initial setup, a migration step is necessary to create database and table schemas needed for initial bootup.
|
||||
Normally, this done by mix aliases like `ecto.setup` defined in the `mix.exs`. As this not available in "released" artifact, [`plausible_migration.ex`](./lib/plausible_migration.ex) facilitates this process.
|
||||
The overlay [scripts](./rel/overlays) take care of these.
|
||||
|
||||
After the release, these are available under `_build/prod/rel/plausible` --
|
||||
@ -58,7 +58,7 @@ docker run plausible:master-12add db seed
|
||||
|
||||
|
||||
## Environment Variables
|
||||
Plausible relies on the several services for operating, the expected environment variables are explaiend below.
|
||||
Plausible relies on the several services for operating, the expected environment variables are explaiend below.
|
||||
|
||||
### Server
|
||||
Following are the variables that can be used to configure the availability of the server.
|
||||
@ -66,38 +66,38 @@ Following are the variables that can be used to configure the availability of th
|
||||
- HOST (*String*)
|
||||
- The hosting address of the server. For running on local system, this can be set to **localhost**. In production systems, this can be your ingress host.
|
||||
- PORT (*Number*)
|
||||
- The port on which the server is available.
|
||||
- The port on which the server is available.
|
||||
- SECRET_KEY_BASE (*String*)
|
||||
- An internal secret key used by [Phoenix Framework](https://www.phoenixframework.org/). Follow the [instructions](https://hexdocs.pm/phoenix/Mix.Tasks.Phx.Gen.Secret.html#content) to generate one.
|
||||
- ENVIRONMENT (*String*)
|
||||
- The current running environment. _defaults to **prod**_
|
||||
- The current running environment. _defaults to **prod**_
|
||||
- APP_VERSION (*String*)
|
||||
- The version of the app running. _defaults to current docker tag_
|
||||
|
||||
- The version of the app running. _defaults to current docker tag_
|
||||
|
||||
### Default User Generation
|
||||
For self-hosting, a default user is generated during the [Database Migration](#Database Migration) to access Plausible. To be noted that, a default user is a user whose trial period expires in 100 Years ;).
|
||||
For self-hosting, a default user is generated during the [Database Migration](#Database Migration) to access Plausible. To be noted that, a default user is a user whose trial period expires in 100 Years ;).
|
||||
It is *highly* recommended that you configure these parameters.
|
||||
|
||||
- ADMIN_USER_NAME
|
||||
- The default ("admin") username. _if not provided, one will be generated for you_
|
||||
- The default ("admin") username. _if not provided, one will be generated for you_
|
||||
- ADMIN_USER_EMAIL
|
||||
- The default ("admin") user email. _if not provided, one will be generated for you_
|
||||
- The default ("admin") user email. _if not provided, one will be generated for you_
|
||||
- ADMIN_USER_PWD
|
||||
- The default ("admin") user password. _if not provided, one will be generated for you_
|
||||
- The default ("admin") user password. _if not provided, one will be generated for you_
|
||||
|
||||
### Mailer/SMTP Setup
|
||||
|
||||
- MAILER_ADAPTER (*String*)
|
||||
- The adapter used for sending out e-mails. Available: `Bamboo.PostmarkAdapter` / `Bamboo.SMTPAdapter`
|
||||
- MAILER_EMAIL (*String*)
|
||||
- The email id to use for as _from_ address of all communications from Plausible.
|
||||
- The email id to use for as _from_ address of all communications from Plausible.
|
||||
|
||||
In case of `Bamboo.SMTPAdapter` you need to supply the following variables:
|
||||
|
||||
In case of `Bamboo.SMTPAdapter` you need to supply the following variables:
|
||||
|
||||
- SMTP_HOST_ADDR (*String*)
|
||||
- The host address of your smtp server.
|
||||
- SMTP_HOST_PORT (*Number*)
|
||||
- The port of your smtp server.
|
||||
- The port of your smtp server.
|
||||
- SMTP_USER_NAME (*String*)
|
||||
- The username/email for smtp auth.
|
||||
- SMTP_USER_PWD (*String*)
|
||||
@ -107,7 +107,7 @@ In case of `Bamboo.SMTPAdapter` you need to supply the following variables:
|
||||
- SMTP_RETRIES (*Number*)
|
||||
- Number of retries to make until mailer gives up. _defaults to `2`_
|
||||
- SMTP_MX_LOOKUPS_ENABLED (*Boolean String*)
|
||||
- If MX lookups should be done before sending out emails. _defaults to `false`_
|
||||
- If MX lookups should be done before sending out emails. _defaults to `false`_
|
||||
|
||||
### Database
|
||||
|
||||
@ -134,19 +134,19 @@ For performance reasons, all the analytics events are stored in clickhouse:
|
||||
- [Google Client](https://developers.google.com/api-client-library)
|
||||
- GOOGLE_CLIENT_ID
|
||||
- GOOGLE_CLIENT_SECRET
|
||||
- [Sentry](https://sentry.io/)
|
||||
- [Sentry](https://sentry.io/)
|
||||
- SENTRY_DSN
|
||||
- [Paddle](https://paddle.com/)
|
||||
- PADDLE_VENDOR_AUTH_CODE
|
||||
- [PostMark](https://postmarkapp.com/), only in case of `Bamboo.PostmarkAdapter` mail adapter.
|
||||
- POSTMARK_API_KEY
|
||||
|
||||
Apart from these, there are also the following integrations
|
||||
Apart from these, there are also the following integrations
|
||||
|
||||
- [Twitter](https://developer.twitter.com/en/docs)
|
||||
- TWITTER_CONSUMER_KEY
|
||||
- TWITTER_CONSUMER_SECRET
|
||||
- TWITTER_ACCESS_TOKEN
|
||||
- TWITTER_ACCESS_TOKEN_SECRET
|
||||
- [Slack](https://api.slack.com/messaging/webhooks)
|
||||
- [Slack](https://api.slack.com/messaging/webhooks)
|
||||
- SLACK_WEBHOOK
|
||||
|
||||
@ -35,8 +35,8 @@ We choose the subscription business model rather than the business model of surv
|
||||
|
||||
### Technology
|
||||
|
||||
Plausible Analytics is a standard Elixir/Phoenix application backed by a PostgreSQL database. On the frontend we use
|
||||
[TailwindCSS](https://tailwindcss.com/) for styling and some vanilla Javascript for interactive bits.
|
||||
Plausible Analytics is a standard Elixir/Phoenix application backed by a PostgreSQL database for general data and a Clickhouse
|
||||
database for stats. On the frontend we use [TailwindCSS](https://tailwindcss.com/) for styling and React to make the dashboard interactive.
|
||||
|
||||
### Feedback & Roadmap
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user