1
0
mirror of https://github.com/muety/wakapi.git synced 2023-08-10 21:12:56 +03:00
📊 A minimalist, self-hosted WakaTime-compatible backend for coding statistics
Go to file
2020-10-04 12:16:42 +02:00
.github chore: update build workflow to exclude certain directories 2020-10-04 12:08:58 +02:00
config fix: define flags on init 2020-10-04 11:47:31 +02:00
data Resolve #7. 2020-03-31 11:24:44 +02:00
middlewares refactor: migrate to new config (resolve #54) 2020-10-04 10:37:38 +02:00
migrations fix: attempt to fix invalid fixture query for postgres (fix #52) 2020-09-12 16:32:43 +02:00
models refactor: move config to separate package 2020-09-29 18:55:07 +02:00
routes refactor: migrate to new config (resolve #54) 2020-10-04 10:37:38 +02:00
scripts fix: fix build script to cross-compile with sqlite dependency 2020-04-26 14:35:53 +02:00
services refactor: migrate to new config (resolve #54) 2020-10-04 10:37:38 +02:00
static/assets feat: show placeholders when no data is available (resolve #42) 2020-08-30 16:51:37 +02:00
utils refactor: migrate to new config (resolve #54) 2020-10-04 10:37:38 +02:00
views fix: attempt to fix invalid fixture query for postgres (fix #52) 2020-09-12 16:32:43 +02:00
.dockerignore fix: docker build 2020-04-26 15:07:00 +02:00
.gitignore refactor: migrate to new config (resolve #54) 2020-10-04 10:37:38 +02:00
config.default.yml docs: update docs for new config format 2020-10-04 11:35:23 +02:00
config.ini fix: add legacy config again for backwards-compatibility 2020-10-04 12:16:42 +02:00
doap.rdf Add DOAP description. 2020-04-05 13:36:01 +02:00
Dockerfile fix: adapt docker image to new config format 2020-10-04 11:52:52 +02:00
go.mod feat: introduce legacy config migration 2020-10-04 11:14:44 +02:00
go.sum refactor: migrate to new config (resolve #54) 2020-10-04 10:37:38 +02:00
LICENSE Add license. 2019-05-22 07:32:35 +02:00
main.go docs: update docs for new config format 2020-10-04 11:35:23 +02:00
README.md fix: adapt docker image to new config format 2020-10-04 11:52:52 +02:00
version.txt fix: adapt docker image to new config format 2020-10-04 11:52:52 +02:00
wait-for-it.sh fix: docker build 2020-04-26 15:07:00 +02:00

📈 wakapi

Say thanks Go Report Card Coding Activity

A minimalist, self-hosted WakaTime-compatible backend for coding statistics

Wakapi screenshot

If you like this project, please consider supporting it 🙂. You can donate either through buying me a coffee or becoming a GitHub sponsor. Every little donation is highly appreciated and boosts the developers' motivation to keep improving Wakapi!

👀 Demo

🔥 New: There is a hosted demo version available now. Go check it out! Please use responsibly.

To use the demo version set api_url = https://apps.muetsch.io/wakapi/api/heartbeat. However, this hosted instance might be taken down again in the future, so you might potentially lose your data

⚙️ Prerequisites

On the server side:

  • Go >= 1.13 (with $GOPATH properly set)
  • gcc (to compile go-sqlite3)
    • Fedora / RHEL: dnf install @development-tools
    • Ubuntu / Debian: apt install build-essential
    • Windows: See here
  • Optional: A MySQL- or Postgres database

On your local machine:

⌨️ Server Setup

Run from source

  1. Clone the project
  2. Copy config.default.yml to config.yml and adapt it to your needs
  3. Build executable: GO111MODULE=on go build
  4. Run server: ./wakapi

As an alternative to building from source you can also grab a pre-built release. Steps 2, 3 and 5 apply analogously.

Note: By default, the application is running in dev mode. However, it is recommended to set ENV=production for enhanced performance and security. To still be able to log in when using production mode, you either have to run Wakapi behind a reverse proxy, that enables for HTTPS encryption (see best practices) or set security.insecure_cookies to true in config.yml.

Run with Docker

docker run -d -p 3000:3000 --name wakapi n1try/wakapi

By default, SQLite is used as a database. To run Wakapi in Docker with MySQL or Postgres, see Dockerfile and config.default.yml for further options.

🔧 Configuration

You can specify configuration options either via a config file (default: config.yml, customziable through the -c argument) or via environment variables. Here is an overview of all options.

YAML Key Environment Variable Default Description
env ENVIRONMENT dev Whether to use development- or production settings
app.cleanup WAKAPI_CLEANUP false Whether or not to clean up old heartbeats (be careful!)
app.custom_languages - - Map from file endings to language names
server.port WAKAPI_PORT 3000 Port to listen on
server.listen_ipv4 WAKAPI_LISTEN_IPV4 127.0.0.1 Network address to listen on
server.base_path WAKAPI_BASE_PATH / Web base path (change when running behind a proxy under a sub-path)
security.password_salt WAKAPI_PASSWORD_SALT - Pepper to use for password hashing
security.insecure_cookies WAKAPI_INSECURE_COOKIES false Whether or not to allow cookies over HTTP
db.host WAKAPI_DB_HOST - Database host
db.port WAKAPI_DB_PORT - Database port
db.user WAKAPI_DB_USER - Database user
db.password WAKAPI_DB_PASSWORD - Database password
db.name WAKAPI_DB_NAME wakapi_db.db Database name
db.dialect WAKAPI_DB_TYPE sqlite3 Database type (one of sqlite3, mysql, postgres)
db.max_conn WAKAPI_DB_MAX_CONNECTIONS 2 Maximum number of database connections

💻 Client Setup

Wakapi relies on the open-source WakaTime client tools. In order to collect statistics to Wakapi, you need to set them up.

  1. Set up WakaTime for your specific IDE or editor. Please refer to the respective plugin guide
  2. Make your local WakaTime client talk to Wakapi by editing your local ~/.wakatime.cfg file as follows
api_url = https://your.server:someport/api/heartbeat`
api_key = the_api_key_printed_to_the_console_after_starting_the_server`

You can view your API Key after logging in to the web interface.

🔵 Customization

Aliases

There is an option to add aliases for project names, editors, operating systems and languages. For instance, if you want to map two projects myapp-frontend and myapp-backend two a common project name myapp-web in your statistics, you can add project aliases.

At the moment, this can only be done via raw database queries. For the above example, you would need to add two aliases, like this:

INSERT INTO aliases (`type`, `user_id`, `key`, `value`) VALUES (0, 'your_username', 'myapp-web', 'myapp-frontend');

Types

  • Project ~ type 0
  • Language ~ type 1
  • Editor ~ type 2
  • OS ~ type 3
  • Machine ~ type 4

🔧 API Endpoints

The following API endpoints are available. A more detailed Swagger documentation is about to come (#40).

  • POST /api/heartbeat
  • GET /api/summary
    • string parameter interval: One of today, day, week, month, year, any
  • GET /api/compat/v1/users/current/all_time_since_today (see Wakatime API docs)
  • GET /api/compat/v1/users/current/summaries (see Wakatime API docs)
  • GET /api/health

⤴️ Prometheus Export

If you want to export your Wakapi statistics to Prometheus to view them in a Grafana dashboard or so please refer to an excellent tool called wakatime_exporter.

It is a standalone webserver that connects to your Wakapi instance and exposes the data as Prometheus metrics. Although originally developed to scrape data from WakaTime, it will mostly for with Wakapi as well, as the APIs are partially compatible.

Simply configure the exporter with WAKA_SCRAPE_URI to equal "https://wakapi.your-server.com/api/compat/wakatime/v1" and set your API key accordingly.

🏷 Badges

We recently introduced support for Shields.io badges (see above). Visit your Wakapi server's settings page to see details.

👍 Best Practices

It is recommended to use wakapi behind a reverse proxy, like Caddy or nginx to enable TLS encryption (HTTPS). However, if you want to expose your wakapi instance to the public anyway, you need to set server.listen_ipv4 to 0.0.0.0 in config.yml

⚠️ Important Note

This is not an alternative to using WakaTime. It is just a custom, non-commercial, self-hosted application to collect coding statistics using the already existing editor plugins provided by the WakaTime community. It was created for personal use only and with the purpose of keeping the sovereignity of your own data. However, if you like the official product, please support the authors and buy an official WakaTime subscription!

📓 License

GPL-v3 @ Ferdinand Mütsch