From 0b993a0d04c9e542f1584ce00eab7ee4af0321d2 Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Fri, 18 Nov 2022 14:34:39 +0800 Subject: Fix "build from source" document to clarify the `bindata` tag is required. (#21853) --- docs/content/doc/installation/from-source.en-us.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'docs/content/doc/installation/from-source.en-us.md') diff --git a/docs/content/doc/installation/from-source.en-us.md b/docs/content/doc/installation/from-source.en-us.md index a6493598be..01a5e1eaee 100644 --- a/docs/content/doc/installation/from-source.en-us.md +++ b/docs/content/doc/installation/from-source.en-us.md @@ -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. @@ -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 -- cgit v1.2.3