diff --git a/README.md b/README.md index 76eb08e..aeb365f 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,12 @@ ## Table of Contents * [User Survey](#-user-survey) * [Features](#-features) +* [Roadmap](#-roadmap) * [How to use](#-how-to-use) * [Configuration Options](#-configuration-options) * [API Endpoints](#-api-endpoints) -* [Prometheus Export](#-prometheus-export) +* [Prometheus Export](#%EF%B8%8F-prometheus-export) +* [WakaTime Integration](#%EF%B8%8F-wakatime-integration) * [Best Practices](#-best-practices) * [Developer Notes](#-developer-notes) * [Support](#-support) @@ -58,10 +60,13 @@ I'd love to get some community feedback from active Wakapi users. If you want, p * ✅ Badges * ✅ REST API * ✅ Partially compatible with WakaTime -* ✅ WakaTime relay to use both +* ✅ WakaTime integration * ✅ Support for [Prometheus](https://github.com/muety/wakapi#%EF%B8%8F-prometheus-export) exports * ✅ Self-hosted +## 🚧 Roadmap +Plans for the near future mainly include, besides usual improvements and bug fixes, a UI redesign as well as additional types of charts and statistics (see [#101](https://github.com/muety/wakapi/issues/101), [#80](https://github.com/muety/wakapi/issues/80), [#76](https://github.com/muety/wakapi/issues/76), [#12](https://github.com/muety/wakapi/issues/12)). If you have feature requests or any kind of improvement proposals feel free to open an issue or share them in our [user survey](https://github.com/muety/wakapi/issues/82). + ## ⌨️ How to use? There are different options for how to use Wakapi, ranging from out hosted cloud service to self-hosting it. Regardless of which option choose, you will always have to do the [client setup](#-client-setup) in addition. @@ -199,6 +204,9 @@ It is a standalone webserver that connects to your Wakapi instance and exposes t 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. +## ⤵️ WakaTime Integration +Wakapi plays well together with [WakaTime](https://wakatime.com). For one thing, you can **forward heartbeats** from Wakapi to WakaTime to effectively use both services simultaneously. In addition, there is the option to **import historic data** from WakaTime for consistency between both services. Both features can be enabled in the _Integrations_ section of your Wakapi instance's settings page. + ## 👍 Best Practices It is recommended to use wakapi behind a **reverse proxy**, like [Caddy](https://caddyserver.com) 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` diff --git a/config/config.go b/config/config.go index 05bcda5..cabba17 100644 --- a/config/config.go +++ b/config/config.go @@ -48,7 +48,7 @@ type appConfig struct { AggregationTime string `yaml:"aggregation_time" default:"02:15" env:"WAKAPI_AGGREGATION_TIME"` CountingTime string `yaml:"counting_time" default:"05:15" env:"WAKAPI_COUNTING_TIME"` ImportBackoffMin int `yaml:"import_backoff_min" default:"5" env:"WAKAPI_IMPORT_BACKOFF_MIN"` - ImportBatchSize int `yaml:"import_batch_size" default:"25" env:"WAKAPI_IMPORT_BATCH_SIZE"` + ImportBatchSize int `yaml:"import_batch_size" default:"100" env:"WAKAPI_IMPORT_BATCH_SIZE"` CustomLanguages map[string]string `yaml:"custom_languages"` Colors map[string]map[string]string `yaml:"-"` }