Skip to content

Commit

Permalink
Fix "build from source" document to clarify the bindata tag is requ…
Browse files Browse the repository at this point in the history
…ired. (#21853)
  • Loading branch information
wxiaoguang authored Nov 18, 2022
1 parent 6dbcf72 commit 0b993a0
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/content/doc/installation/from-source.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- `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
[SQLite3](https://sqlite.org/) database. Suggested only for tiny
installations.
Expand All @@ -103,11 +103,10 @@ Depending on requirements, the following build tags can be included.
available to PAM.
- `gogit`: (EXPERIMENTAL) Use go-git variants of Git commands.

Bundling assets into the binary using the `bindata` build tag is recommended for
production deployments. It is possible to serve the static assets directly via a reverse proxy,
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 assets, add the `bindata` tag:
Bundling all assets (JS/CSS/templates, etc) into the binary. Using the `bindata` build tag is required for
production deployments. You could exclude `bindata` when you are developing/testing Gitea or able to separate the assets correctly.

To include all assets, use the `bindata` tag:

```bash
TAGS="bindata" make build
Expand Down

0 comments on commit 0b993a0

Please sign in to comment.