https://github.com/reload/harvester
Welcome to Harvester, a service which fetch data from HarvestApp and have a simple API to get data out.
https://github.com/reload/harvester
Last synced: 12 months ago
JSON representation
Welcome to Harvester, a service which fetch data from HarvestApp and have a simple API to get data out.
- Host: GitHub
- URL: https://github.com/reload/harvester
- Owner: reload
- Created: 2014-06-02T08:37:20.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T12:21:33.000Z (about 2 years ago)
- Last Synced: 2025-03-12T09:44:26.472Z (over 1 year ago)
- Language: PHP
- Homepage: http://reload.harvester.dk
- Size: 368 KB
- Stars: 0
- Watchers: 13
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Harvester
Welcome to Harvester, a service which fetch data from HarvestApp and
have a simple API to get data out.
## Get started
### 1. Create the config
```shell
make create-config
```
### 2. Fill in envs in `docker-compose.override.yml`
```shell
HARVESTER_HARVEST_USER: harvest_account_email@email.com
HARVESTER_HARVEST_PASSWORD: secretpassword
# only use the actual name, e.g. "reload". *Not* the full url (reload.harvestapp.com)
HARVESTER_HARVEST_ACCOUNT: harvestapp_account_name
```
The credentials can be found in LastPass. Search for __"Harvester API"__.
### 3. Get everything up and running. This takes ~30 minutes
```shell
make up
```
When your terminal looks something likes this:
```shell
server_1 | *** Running /etc/my_init.d/00_regen_ssh_host_keys.sh...
server_1 | *** Running /etc/my_init.d/harvester...
server_1 | *** Running /etc/rc.local...
server_1 | *** Booting runit daemon...
server_1 | *** Runit started as PID 10
server_1 | tail: unrecognized file system type 0x794c7630 for ‘/var/log/apache2/error.log’. please report this to bug-coreutils@gnu.org. reverting to polling
server_1 | tail: unrecognized file system type 0x794c7630 for ‘/var/log/syslog’. please report this to bug-coreutils@gnu.org. reverting to polling
server_1 | AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 172.28.0.2. Set the 'ServerName' directive globally to suppress this message
server_1 | AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 172.28.0.2. Set the 'ServerName' directive globally to suppress this message
server_1 | [Fri Apr 17 08:35:03.303829 2020] [mpm_prefork:notice] [pid 21] AH00163: Apache/2.4.7 (Ubuntu) PHP/5.5.9-1ubuntu4.29 configured -- resuming normal operations
server_1 | [Fri Apr 17 08:35:03.303888 2020] [core:notice] [pid 21] AH00094: Command line: 'apache2 -D FOREGROUND'
server_1 | Apr 17 08:35:03 d37b70b08786 syslog-ng[18]: syslog-ng starting up; version='3.5.3'
```
__The wait is over!__
### 4. Create an admin user
``` shell
make create-admin
```
Fill in your password of choice and now you are ready to login with the user __harvest@reload.dk__ and your new password at [http://harvester.docker/login](http://harvester.docker/login).
### 5. Harvester is now accessible at
- Login: [http://harvester.docker/login](http://harvester.docker/login)
- Admin: [http://harvester.docker/admin](http://harvester.docker/admin)
- Docs: [http://harvester.docker/api/doc](http://harvester.docker/api/doc)
## CLI
For fetching data from the HarvestApp API and managing users.
### User management
Print the available configuration for the user command.
```shell
docker-compose exec server app/console help harvester:user
```
### Data fetching
Print the available configuration for the fetch command.
```shell
docker-compose exec server app/console help harvester:fetch
```
Run the fetch command without parameters. Will fetch everything from HarvestApp (~30 minutes).
```shell
docker-compose exec server app/console harvester:fetch
```
Data from this month
```shell
docker-compose exec server app/console harvester:fetch `date "+%Y%m01"`
```
Since yesterday
```shell
docker-compose exec server app/console harvester:fetch --updated-yesterday
```
Delete entries and repopulate within a given time span
```shell
docker-compose exec server app/console harvester:refresh `date "+%Y%m01"`
```
Delete entries and repopulate within a static amount of days
```shell
docker-compose exec server app/console harvester:refresh --days=30
```
## Hosting
Harvester is currently hosted with Kubernetes at Google Cloud Platform in the project: `reload-internal-alpha`
It is deployed using [helm](https://helm.sh/docs/topics/charts/)
For more info, please see our [helm-chart](./helm-chart)