realaravinth/bench-forgejo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix "build from source" document to clarify the bindata tag is required. (#21853)

Browse source
This commit is contained in:
wxiaoguang 2022-11-18 14:34:39 +08:00 committed by GitHub
parent 6dbcf724ac
commit 0b993a0d04
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/content/doc/installation/from-source.en-us.md
View file

@ -94,7 +94,7 @@ are provided to keep the build process as simple as possible.
Depending on requirements, the following build tags can be included. Depending on requirements, the following build tags can be included.
- `bindata`: Build a single monolithic binary, with all assets included. - `bindata`: Build a single monolithic binary, with all assets included. Required for production build.
- `sqlite sqlite_unlock_notify`: Enable support for a - `sqlite sqlite_unlock_notify`: Enable support for a
[SQLite3](https://sqlite.org/) database. Suggested only for tiny [SQLite3](https://sqlite.org/) database. Suggested only for tiny
installations. installations.
@ -103,11 +103,10 @@ Depending on requirements, the following build tags can be included.
available to PAM. available to PAM.
- `gogit`: (EXPERIMENTAL) Use go-git variants of Git commands. - `gogit`: (EXPERIMENTAL) Use go-git variants of Git commands.
Bundling assets into the binary using the `bindata` build tag is recommended for Bundling all assets (JS/CSS/templates, etc) into the binary. Using the `bindata` build tag is required for
production deployments. It is possible to serve the static assets directly via a reverse proxy, production deployments. You could exclude `bindata` when you are developing/testing Gitea or able to separate the assets correctly.
but in most cases it is not necessary, and assets should still be bundled in the binary.
You may want to exclude bindata while developing/testing Gitea. To include all assets, use the `bindata` tag:
To include assets, add the `bindata` tag:
```bash ```bash
TAGS="bindata" make build TAGS="bindata" make build