ce72/api
1
0
Fork 0
forked from vikunja/vikunja
Code Issues Pull Requests Packages Projects Releases Wiki Activity
9,662 Commits 17 Branches 30 Tags 709 MiB
main
Commit Graph

162 Commits

Author SHA1 Message Date
David Baakman
8bc23b3a54 docs: remove superfluous yaml code block (#2342) 
Fixes the ```yaml shown in the documentation.

Reviewed-on: vikunja/vikunja#2342
Reviewed-by: konrad <k@knt.li>
Co-authored-by: David Baakman <kolaente@davidbaakman.nl>
Co-committed-by: David Baakman <kolaente@davidbaakman.nl>
 2024-06-02 19:20:09 +00:00
kolaente
eee7b060b6
fix(docs): typos 
Apply patch from https://github.com/go-vikunja/vikunja/issues/263
 2024-05-07 16:06:17 +02:00
kolaente
73bf119409
docs: clarify version checkout when building from source 
Related to vikunja/vikunja#2270 (comment)
 2024-04-12 23:39:27 +02:00
kolaente
4e49ec9e16
docs: clarify automatic openid team creation 2024-04-10 23:05:45 +02:00
kolaente
0557d4b5bb
docs: clarify transitioning from unstable to release 2024-04-09 22:43:27 +02:00
Raymi306
1adaa73141 docs: fix build-from-sources docs mistake (#2251) 
While attempting to build on OpenBSD without having built the frontend, I ran into the following error:

`frontend/embed.go:21:12: pattern dist: no matching files found`

I saw in the docs to create a directory and touch a file, this resulted in a second error:

`frontend/embed.go:21:12: pattern dist: cannot embed directory dist: contains no embeddable files`

Creating the index.html file inside the new directory allowed me to build Vikunja

Reviewed-on: vikunja/vikunja#2251
Co-authored-by: Raymi306 <raymi306@gmail.com>
Co-committed-by: Raymi306 <raymi306@gmail.com>
 2024-04-08 07:48:12 +00:00
waza-ari
be54a361fd docs: add details about supported and required OIDC claims (#2201) 
Again based on a [community question](https://community.vikunja.io/t/oidc-how-can-i-prevent-username-from-being-set-randomly-how-can-users-find-each-other/2138/2), it might make sense to add a few more details about the OIDC behaviour to the docs.

Co-authored-by: Daniel Herrmann <daniel.herrmann1@gmail.com>
Reviewed-on: vikunja/vikunja#2201
Co-authored-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
Co-committed-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
 2024-03-15 13:50:46 +00:00
waza-ari
4bb1d5edfc fix(docs): openid docs whitespace formatting (#2186) 
Co-authored-by: Daniel Herrmann <daniel.herrmann1@gmail.com>
Reviewed-on: vikunja/vikunja#2186
Reviewed-by: konrad <k@knt.li>
Co-authored-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
Co-committed-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
 2024-03-10 14:43:04 +00:00
Elscrux
4b4a7f3c0a docs: fix broken link in migration docs (#2185) 
Seems like one link was broken, this attempts to fix that.

Co-authored-by: Elscrux <nickposer2102@gmail.com>
Reviewed-on: vikunja/vikunja#2185
Reviewed-by: konrad <k@knt.li>
Co-authored-by: Elscrux <elscrux@gmail.com>
Co-committed-by: Elscrux <elscrux@gmail.com>
 2024-03-10 14:12:00 +00:00
waza-ari
ffa82556e0 feat(teams): add public flags to teams to allow easier sharing with other teams (#2179) 
Resolves #2173
Co-authored-by: Daniel Herrmann <daniel.herrmann1@gmail.com>
Reviewed-on: vikunja/vikunja#2179
Reviewed-by: konrad <k@knt.li>
Co-authored-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
Co-committed-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
 2024-03-10 14:04:32 +00:00
Elscrux
1d5517b53a docs: add migrations setup doc (#2183) 
This should hopefully make the migration process for obvious, as discussed here https://community.vikunja.io/t/trello-import-issues/2110/7

Co-authored-by: Elscrux <nickposer2102@gmail.com>
Reviewed-on: vikunja/vikunja#2183
Reviewed-by: konrad <k@knt.li>
Co-authored-by: Elscrux <elscrux@gmail.com>
Co-committed-by: Elscrux <elscrux@gmail.com>
 2024-03-10 13:32:27 +00:00
Daniel Herrmann
6e52db76dc docs: clarify what to use for authurl 2024-03-10 11:39:23 +00:00
waza-ari
92d9c31101 docs: improve OpenID documentation (#2151) 
This PR stems from issue #2150, in turn following up on PR #1393

It adds additional details around the OIDC authentication feature, as well as details about how the team assignment works.

Co-authored-by: Daniel Herrmann <daniel.herrmann1@gmail.com>
Reviewed-on: vikunja/vikunja#2151
Reviewed-by: konrad <k@knt.li>
Co-authored-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
Co-committed-by: waza-ari <daniel.herrmann@makerspace-darmstadt.de>
 2024-03-03 22:19:16 +00:00
kolaente
6db8728420
docs: add missing front matter 2024-03-02 15:34:59 +01:00
viehlieb
ed4da96ab1 feat: assign users to teams via OIDC claims (#1393) 
This change adds the ability to sync teams via a custom openid claim. Vikunja will automatically create and delete teams as necessary, it will also add and remove users when they log in. These teams are fully managed by Vikunja and cannot be updated by a user.

Co-authored-by: kolaente <k@knt.li>
Reviewed-on: vikunja/vikunja#1393
Resolves vikunja/vikunja#1279
Resolves https://github.com/go-vikunja/vikunja/issues/42
Resolves vikunja/vikunja#950
Co-authored-by: viehlieb <pf@pragma-shift.net>
Co-committed-by: viehlieb <pf@pragma-shift.net>
 2024-03-02 08:47:10 +00:00
kolaente
09d446765d
docs: update config docs 2024-03-01 11:47:29 +01:00
kolaente
a0e812395f
feat(docker)!: use scratch as base image 
This change modifies the docker image so that it uses the scratch image instead of alpine. This is possible because the Vikunja binary is now entirely statically compiled, wich no dependencies on any system c libraries.

This also changes the default path for the sqlite file in the docker image (breaking). When using sqlite in docker, the VIKUNJA_DATABASE_PATH config variable or the file mount must be changed to prevent data loss.
 2024-02-25 22:49:04 +01:00
kolaente
e532979101
docs: clarify public url usage in installation 2024-02-19 19:04:16 +01:00
kolaente
5ab720d709
docs: remove outdated information 2024-02-14 10:21:51 +01:00
kolaente
7ae38c5ac1
docs: fix postgres example healthcheck 2024-02-14 10:21:27 +01:00
kolaente
89e349f2fd
docs: fix database healthcheck command 2024-02-13 20:38:53 +01:00
kolaente
18374c2e52
docs: fix healthcheck and mariadb password 2024-02-13 09:55:12 +01:00
kolaente
001268a33e
docs: add healthcheck to docker compose examples 2024-02-11 18:39:53 +01:00
kolaente
1255bdc4ab
docs: add desktop packages 2024-02-11 16:54:53 +01:00
kolaente
99856b2031
docs: add missing traefik label 2024-02-11 15:57:22 +01:00
kolaente
eec53e8a54
docs: mention installation of rpm packages 2024-02-11 15:56:34 +01:00
kolaente
1984527fae
docs: adjust documentation to reflect single-binary deployments 2024-02-09 19:09:19 +01:00
kolaente
fceb638e75
docs: remove mention of vikunja/api and vikunja/frontend repos 2024-02-08 14:31:02 +01:00
erri120
4615b4dbfb docs: add Authentik example config (#1660) 
Reviewed-on: vikunja/api#1660
Reviewed-by: konrad <k@knt.li>
Co-authored-by: erri120 <erri120@protonmail.com>
Co-committed-by: erri120 <erri120@protonmail.com>
 2023-12-01 14:08:14 +00:00
kolaente
c6c465c273
feat: make unauthenticated user routes rate limit configurable 2023-11-28 22:27:51 +01:00
kolaente
a2925cf55b
docs: clarify minimum required go version 2023-11-05 17:09:46 +01:00
kolaente
c3947e1016
docs(webhooks): add webhook config to sample config 2023-10-17 20:35:13 +02:00
kolaente
a1d0541a7a
docs: add config guide for NGINX Proxy Manager 
Taken from https://github.com/go-vikunja/frontend/issues/28#issuecomment-1765096790
 2023-10-17 19:00:40 +02:00
kolaente
e1525fca6e
docs: clarify required language code 2023-10-17 18:35:06 +02:00
kolaente
70d1903dca
docs: add typesense setup 2023-09-29 12:30:53 +02:00
kolaente
97b5cd306f
feat: add demo mode flag 
Related to vikunja/frontend#2453
 2023-09-01 17:47:43 +02:00
kolaente
c1ccbe8186
feat(docs): update sample config and docs about Typesense config 2023-08-29 11:23:52 +02:00
cr1xus
665c046717 docs: Add Caddyfile to reverse proxies setup (#1580) 
Reviewed-on: vikunja/api#1580
Co-authored-by: cr1xus <christoearth@gmail.com>
Co-committed-by: cr1xus <christoearth@gmail.com>
 2023-08-21 11:45:35 +00:00
kolaente
d83e3a0a03
chore: remove cache options 
Cache was not working correctly, added more complexity and actually made response times slower. Because of this, I'm removing all cache options until we figure out a better solution.

Resolves vikunja/api#1496
Resolves vikunja/api#907
 2023-06-08 17:05:36 +02:00
jontyms
9e5c95fd6d fix(docs): Added Keycloak OpenID example (#1521) 
Reviewed-on: vikunja/api#1521
Reviewed-by: konrad <k@knt.li>
Co-authored-by: jontyms <jontyms@protonmail.com>
Co-committed-by: jontyms <jontyms@protonmail.com>
 2023-05-23 11:14:35 +00:00
Aaron Ogle
a16fd67b51
docs: add docs for installing with sqlite in docker (#70) 
Co-authored-by: kolaente <k@knt.li>
Reviewed-On: https://github.com/go-vikunja/api/pull/70
 2023-04-13 11:42:15 +02:00
Dominik Pschenitschni
aaa0593289 feat(docs): various improvements 
- removing spaces at end of line
- fixing spelling and grammar mistakes
- making sure 'Vikunja' is spelled the same way everywhere
- prefer using editors word wrap instead of hardcoding word wrap in markdown (reason: different word wrap per editor & end of line space)
- add newline add end where missing
- remove double colon at end of headlines
- remove unnecessary indention
- make sure code blocks and headlines etc always have an empty line around
 2023-04-11 16:42:59 +00:00
Dominik Pschenitschni
6cbaf5bbf9 fix(spelling): in config sample (#1489) 
Co-authored-by: Dominik Pschenitschni <mail@celement.de>
Co-authored-by: kolaente <k@knt.li>
Reviewed-on: vikunja/api#1489
Reviewed-by: konrad <k@knt.li>
Co-authored-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de>
Co-committed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de>
 2023-04-11 16:42:41 +00:00
Dominik Pschenitschni
8d7825171f fix(docs): semver link (#1470) 
Co-authored-by: Dominik Pschenitschni <mail@celement.de>
Reviewed-on: vikunja/api#1470
Co-authored-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de>
Co-committed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de>
 2023-04-11 12:09:12 +00:00
kolaente
22f89c1ccc
docs: add information about our Helm Chart 2023-04-05 13:54:18 +02:00
kolaente
327bb3bed9
docs: remove outdated information 2023-04-03 12:07:50 +02:00
Skyler Hawthorne
ae5a3cf020 update prometheus docs for clarity (#1458) 
Make it clearer that the `/metrics` endpoint is under `/api/v1`

Co-authored-by: Skyler Hawthorne <skyler@dead10ck.com>
Reviewed-on: vikunja/api#1458
Reviewed-by: konrad <k@knt.li>
Co-authored-by: Skyler Hawthorne <dead10ck@noreply.kolaente.de>
Co-committed-by: Skyler Hawthorne <dead10ck@noreply.kolaente.de>
 2023-04-02 18:10:55 +00:00
kolaente
9590b82c11 feat: add logging options to mailer settings 2023-03-25 12:28:56 +00:00
kolaente
8dc6c95333
docs: update references to list 2023-03-14 17:39:46 +01:00
kolaente
4de0efec1d
docs: add link to tutorial for installing Vikunja on Synology 2023-03-11 14:55:30 +01:00