Skip to content

Commit 37b6b81

Browse files
committed
various other updates
1 parent f4492da commit 37b6b81

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

content/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ draft: false
66

77
# jfa-go wiki
88

9+
Stuff here will apply to the latest git version, but will probably work on older versions.
10+
If you desperately need info for an older version, browse through the commits to find one around the same time as the version's release.
11+
912
You can find the source for this wiki [here](https://github.com/hrfee/jfa-go-wiki).
1013

1114
If you think something's missing here, feel free to make a PR.

content/docs/build/binary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ To build, you need to compile the typescript and go, and generate email template
1212
required:
1313
git
1414
python >= 3.6
15-
go >= 1.16
16-
node.js and npm (for tsc/esbuild, a17t, mjml, remixicon, markdown parser & uncss)
15+
go >= 1.20
16+
node.js and npm (for tsc/esbuild, tailwind/a17t, mjml, remixicon, markdown parser & uncss)
1717
optional:
1818
libayatana-appindicator or equivalent (if building with tray icon on linux)
1919
gcc-mingw-w64-x86-64 or equivalent (if cross-compiling for windows on linux/macOS)
@@ -36,7 +36,7 @@ A Makefile is provided, which requires the `make` command. Simply clone the repo
3636

3737
* You can optionally provide the path/name of the `go` executable manually with `make all GOBINARY=<path to go>`.
3838

39-
* More build-time variables exist, which are explained on the [contributing page](/docs/build/dev).
39+
* More build-time variables exist, which are explained on the [contributing page](/docs/dev).
4040

4141
## Goreleaser
4242
[goreleaser](https://github.com/goreleaser/goreleaser) is used to publish the packages seen in the release section. The `scripts/version.sh` wrapper generates the version and provides it to goreleaser with an environment variable.

content/docs/dev.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,17 @@ The Makefile is more suited towards development than other build methods, and pr
1717

1818
Prefix each of these with `make DEBUG=on `:
1919
* `all` will download deps and build everything. The executable and data will be placed in `build`. This is only necessary the first time.
20+
* `quick` skips a couple steps, namely `npm`, `swagger`, and `email` to make things a bit quicker when you're not working on that sorta stuff.
2021
* `npm` will download all node.js build-time dependencies.
2122
* `compile` will only compile go code into the `build/jfa-go` executable.
2223
* `typescript` will compile typescript w/ sourcemaps into `build/data/web/js`.
2324
* `bundle-css` will bundle CSS and place it in `build/data/web/css`.
24-
* `inline` will inline the css and javascript used in the single-file crash report webpage.
25+
* `inline-css` will inline the css and javascript used in the single-file crash report webpage.
2526
* `configuration` will generate the `config-base.json` (used to render settings in the web ui) and `config-default.ini` and put them in `build/data`.
2627
* `email` will compile email mjml, and copy the text versions in to `build/data`.
2728
* `swagger`: generates swagger documentation for the API.
28-
* `copy` will copy iconography, html, language files and static data into `build/data`.
29+
* `variants-html` will copy over html files and runs the `missings-colors.js` script to insert missing dark mode tags.
30+
* `copy` will copy iconography, language files and other static data into `build/data`.
2931

3032
## Environment variables
3133

@@ -37,6 +39,7 @@ Prefix each of these with `make DEBUG=on `:
3739
* `GOBINARY=<path to go>`: Alternative path to go executable. Useful for testing with unstable go releases.
3840
* `VERSION=v<semver>`: Alternative verision number, useful to test update functionality.
3941
* `COMMIT=<short commit>`: Self explanatory.
42+
* `BUILDTIME=<unix timestamp>`: Build timestamp to be shown in "About", and used for update detection.
4043
* `LDFLAGS=<ldflags>`: Passed to `go build -ldflags`.
4144
* `E2EE=on/off`: Enable/disable end-to-end encryption support for Matrix, which is currently very broken. Must subsequently be enabled (with Advanced settings enabled) in Settings > Matrix.
4245
* `TAGS=<tags>`: Passed to `go build -tags`.
@@ -47,4 +50,4 @@ Prefix each of these with `make DEBUG=on `:
4750

4851
Static Web API docs can be accessed by clicking [Web API Docs](https://api.jfa-go.com) on the sidebar or here.
4952

50-
A live version of the swagger documentation is available by running jfa-go with the `-swagger` argument to make it available at `http://localhost:8056/swagger/index.html`. If you're introducing any new routes when working on the API, make sure to give them a proper description above the function (see other routes in `api.go` as well as the [swaggo](https://github.com/swaggo/swag) documentation), and to put it in the appropriate category. If a struct used as a parameter or return type needs explanation, put descriptions of each field as a comment next to it (see [models.go](https://github.com/hrfee/jfa-go/blob/main/models.go)).
53+
A live version of the swagger documentation is available by running jfa-go with the `-swagger` argument to make it available at `http://localhost:8056/swagger/index.html`. If you're introducing any new routes when working on the API, make sure to give them a proper description above the function (see other routes in `api.go` as well as the [swaggo](https://github.com/swaggo/swag) documentation), and to put it in the appropriate category and/or file (e.g. `api-discord.go` for a discord-only method). If a struct used as a parameter or return type needs explanation, put descriptions of each field as a comment next to it (see [models.go](https://github.com/hrfee/jfa-go/blob/main/models.go)).

content/menu/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ headless = true
77
- External Services
88
- [Ombi]({{< relref "/docs/ombi" >}})
99
- [(re)CAPTCHA]({{< relref "/docs/captcha" >}})
10-
- [Chat bots]({{< relref "/docs/bots" >}})
10+
- [Chat Bots]({{< relref "/docs/bots" >}})
1111
- [Discord]({{< relref "/docs/bots/discord" >}})
1212
- [FAQ]({{< relref "/docs/bots/discord-faq" >}})
1313
- [Telegram]({{< relref "/docs/bots/telegram" >}})

0 commit comments

Comments
 (0)