91 Commits

Author SHA1 Message Date
David Pursehouse
a767f08db3 Merge branch 'stable-3.1'
* stable-3.1:
  Update highlight.js
  Add "Page ..." next to back and forward arrows
  Fix the size of the commit message box
  Bazel: Fix issues flagged by buildifier
  Document that gerrit supports JDK 11
  lib/lucene: merge jars using a java_binary rule

Change-Id: I9807d05de588e8437310ade18e2e5e9c84d2fe27
2020-01-10 14:20:23 +09:00
David Pursehouse
6b8318d247 Merge branch 'stable-3.0' into stable-3.1
* stable-3.0:
  Update highlight.js
  Bazel: Fix issues flagged by buildifier
  Document that gerrit supports JDK 11
  lib/lucene: merge jars using a java_binary rule

Change-Id: Ibac37e9cafd7dfbd1e565f9492a90733edd38f26
2020-01-10 14:17:35 +09:00
David Pursehouse
bf64e2d354 Merge branch 'stable-2.16' into stable-3.0
* stable-2.16:
  Update highlight.js
  Bazel: Fix issues flagged by buildifier
  Document that gerrit supports JDK 11
  lib/lucene: merge jars using a java_binary rule

Adjust Documentation/licenses.txt to reflect new name of merged Lucene
library due to "lib/lucene: merge jars using a java_binary rule".

Change-Id: Iae42e901c8756e46effd1302df9449e37c52f262
2020-01-10 10:37:45 +09:00
David Ostrovsky
841e3927dd Document that gerrit supports JDK 11
Change-Id: I430a2022764e526bea70d97f5a06419f2d968f8d
2020-01-09 01:06:16 +01:00
Marian Harbach
ebeb15460c Enabling linkattrs explicitly on doc pages having external links
Asciidoc may fail to render link attributes for external links
supposed to open in a new window correctly. This change adds
:linkattrs: to the beginning of such files to force parsing link
attributes correctly.

Bug: Issue 12068
Change-Id: If18be60de646ff78f672239dd4fa435fd4fd92ab
2019-12-13 10:59:57 +00:00
Marian Harbach
34253376e6 Make all external links in the documentation open in a new window
To make it easier to stay on track when reading documentation, I
added ",role=external,window=_blank" to all links in the
documentation directory that were not pointing at another piece of documentation.

Change-Id: I94bf254c90f8ebce067c765be0a2932b755a045a
2019-12-10 22:54:40 +01:00
David Pursehouse
97e2a12000 Merge branch 'stable-3.0' into stable-3.1
* stable-3.0:
  Use consistent capitalization for term NoteDb in documentation
  Document how to backup Gerrit
  Update rules_closure to latest version

Change-Id: I91e82cc4cbf8336ca5c9b47fcb380dfacae6a57f
2019-12-07 09:20:20 +09:00
David Pursehouse
0e3b7bcb9c Merge branch 'stable-2.16' into stable-3.0
* stable-2.16:
  Use consistent capitalization for term NoteDb in documentation
  Document how to backup Gerrit
  Update rules_closure to latest version

Change-Id: I4847dcda27466ece557641e9c579fcf70f7f88c1
2019-12-07 09:19:37 +09:00
Matthias Sohn
0d2135640c Document how to backup Gerrit
Bug: Issue 11440
Change-Id: Ia4514e28c82b97375e0f896d86654c9a9fcbf15d
2019-12-05 11:03:34 +01:00
Philip Brown
e3aa8b1d39 fix broken download urls
Change-Id: I3716a95299a3d43aaf945b3d423462816b4f4b7d
2019-06-21 21:24:41 +00:00
Dave Borowitz
ada289c6df Update most documentation for NoteDb
Remove outdated references to ReviewDb. Where ambiguous terms like
"database" are used, make sure they are still technically accurate, or
else remove them.

After this change, all documentation should be up to date with respect
to the database backend, with the exception of note-db.txt itself.

Change-Id: I7134087dc56070788e81ada6ac504b3c8fe84c4c
2019-01-11 14:44:23 -08:00
Edwin Kempin
64a87764c9 install.txt: Remove info about using external database
ReviewDb no longer exists and NoteDb is now always used.

Change-Id: I01c613e5b3ace4a8874b270a692bd1972774e947
Signed-off-by: Edwin Kempin <ekempin@google.com>
2018-12-10 10:42:14 -08:00
Edwin Kempin
e35648be3c Remove unused DatabaseConfigModule and DatabaseConfigInitializer implementations
ReviewDb is gone and we no longer need to initialize the database
section in gerrit.config on init.

Change-Id: Id77d3293db7c769f25033016bee398aad0054ba0
Signed-off-by: Edwin Kempin <ekempin@google.com>
2018-12-10 10:42:14 -08:00
David Pursehouse
5b2f0d4b4e Merge branch 'stable-2.15'
* stable-2.15:
  BranchApi: Add missing throws declaration on NotImplemented#reflog
  FormatUtil: Fix Math#round() truncation error flagged by error-prone
  ReflogIT: Add test coverage for reflog permissions
  ChangeIT: Move reflog test to ReflogIT
  ChangeIT: Fix and expand reflog test
  BranchApi: Add method to get the branch's reflog
  GetReflog: Move ReflogEntryInfo to a separate class in extension API
  Fix http_archive rule in WORKSPACE
  ConfigInfoImpl: Return raw byte value for effective value
  TransferConfig: Move getEffectiveMaxObjectSizeLimit to ProjectState
  ProjectIT: Factor out a method to set the max object size limit
  Documentation: linux-quickstart - include Java 8 requirement
  Documentation: Include Java 8 requirement in installation notes
  Documentation: Remove 'install-quick' page in favour of 'linux-quickstart'

Change-Id: I895790a8b2f9e8439e91c15ba4ee9a5a14a4ee94
2018-08-22 21:59:06 +09:00
David Pursehouse
7acae7f2f2 Merge branch 'stable-2.14' into stable-2.15
* stable-2.14:
  ProjectIT: Factor out a method to set the max object size limit
  Documentation: Include Java 8 requirement in installation notes

Change-Id: Ia68061cca3a46aa9744f2c1d6b9814eb2f092d30
2018-08-20 09:35:45 +09:00
Gert van Dijk
a9d5511375 Documentation: Include Java 8 requirement in installation notes
Bug: Issue 7843
Change-Id: I763800eab693c357eace4182c3bafa28c622b94d
2018-08-16 12:07:30 +02:00
Janet Davies
0c1a621540 Copy edits to dev-readme.txt, install.txt, and linux-quickstart.txt
Change-Id: Ifdd4cee178a70f216bfae5106d1ef92fad7d32d1
2018-05-31 19:49:48 +00:00
David Pursehouse
a625c0fc18 Merge branch 'stable-2.14' into stable-2.15
* stable-2.14:
  Documentation: Remove references to optional BouncyCastle libraries

Change-Id: I7a0a6063b96a8655630754c4e3a62d2dd4578c66
2018-01-12 21:34:22 +09:00
Gert van Dijk
47b0ed3ff7 Documentation: Remove references to optional BouncyCastle libraries
BouncyCastle is bundled with Gerrit since 2.14:
https://www.gerritcodereview.com/releases/2.14.md#Bouncy-Castle-Libraries

Documentation/install-j2ee.txt still needs an update to this.

Change-Id: I461d5d5f7da5bd25f99941fcc525113d5ac09bea
2018-01-12 10:03:52 +01:00
David Pursehouse
64df83ae7d Use "gerrit" as the Gerrit user instead of "gerrit2"
We're still on Gerrit version 2.x but when we move to 3.0 it
will not make sense to have the user named "gerrit2".

Update all the documentation to refer to "gerrit" instead.

Also change the Jetty configuration to use "gerrit" instead.

Change-Id: I43a343669ac936b0585ee15e07d15643f9c3d6eb
2017-07-04 21:20:47 +09:00
David Pursehouse
7b409444dc Documentation: Specify JRE rather than JDK
It should not be necessary to require the JDK to run Gerrit. The JRE
should be enough.

Change-Id: Iaac64bc37c5cc4b352d1a489e6bc3c71ccd0fd8b
2016-11-15 12:12:27 -08:00
David Pursehouse
86a6376435 Merge changes from topic 'win32'
* changes:
  New daemon start/stop methods for use with Procrun
  Correctly call ssh-keygen on Win32 with empty passphrase
  Redirect output from ssh-keygen call to console to see potential errors
2016-09-23 12:12:11 +00:00
David Ostrovsky
3931c16bdb Build with Java 8
Change-Id: I06f811fc46a606b719582c0724e8d0c89e823b37
2016-09-20 10:19:52 +02:00
Michael Ochmann
8129eced3a Harmonize notation of admonition blocks in documentation
There were several different notations used for NOTE and IMPORTANT
sections that sometimes didn't even render correctly.

Change-Id: I744cb0922f4bb4c99282984a487761f2c1bd6d4a
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-08 15:42:31 +02:00
Michael Ochmann
b99feabd88 Fix formatting of example blocks
With the new stylesheet example blocks (delimited with ====) are
rendered as rather intrusive boxes with large padding in yellow
and grey.

This patch replaces the example blocks with simple code blocks
(delimited with ----) that better match the overall style of the
documentation.

Change-Id: Id95387cdb153332c2066e2d5e378697647dbca52
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-07 14:06:31 +02:00
Rafal Klys
6c454be4fe New daemon start/stop methods for use with Procrun
Added additional entry points GerritLauncher.daemonStart and
GerritLauncher.daemonStop for use when hosting Gerrit in some other
process. The intention of this is to make it an easy fit to the [Apache
Commons Daemon Procrun][1]. This adds an easy way to host Gerrit with
embedded Jetty as Windows Service.

Also moved a bit of logic in Daemon from anonymous thread into the stop
method.

[1]: http://commons.apache.org/proper/commons-daemon/procrun.html

Change-Id: Ie1fd3b7fceb56e159dc7f02fbcf481b0fcdb08e2
2016-04-25 04:45:14 +00:00
Shawn Pearce
6d7ebc6318 Offer downloads through https://www.gerritcodereview.com/download/
Change-Id: Ibd0aa9a14f533771986cc1d43a712716457d424c
2015-06-12 19:07:37 -07:00
Stefan Lay
08ba473e22 Fix inconsistency in documentation
The page with the title "Project Configuration" was referred to as
"Project Setup". Moreover, it was contained in a file with the name
"project-setup.txt".

Change-Id: Iab834981893967bfbcba8214e118689ea348b93b
Signed-off-by: Stefan Lay <stefan.lay@sap.com>
2014-05-07 14:51:17 +02:00
Mark Derricutt
de6c16d728 Add support for JCE (Java Cryptography Extension) ciphers
Configures the SSHD daemon to enable support the extra strength
ciphers -if- available in the current JRE. These extensions can be
installed by downloading the JCE policy files from Oracle and
following the installation instructions.

Change-Id: Idd934a29b049b61cddadde5bf797514fcbc654d9
2014-04-21 12:44:05 +00:00
Yuxuan 'fishy' Wang
61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00
David Pursehouse
0c4bde4669 Update Java version to 1.7 in documentation
Change-Id: I2045067160dee3a791b39fec8cc1636fe21c6ba3
2013-12-10 14:12:56 +09:00
Yuxuan 'fishy' Wang
99cb68dec4 Added searchbox to documentation.
This provides the entry point of the documentation search feature.

Change-Id: Iea2b707995c0e042829db509927384dcec7aaf43
2013-11-05 12:49:43 -08:00
David Pursehouse
626f8b56a8 Add missing steps for daemon auto start/stop in install documentation
To correctly configure the daemon to start and stop with the operating
system, some lines need to be enabled in the gerrit.sh script.

Mention this in the documentation.

Bug: Issue 2188
Change-Id: Id423cff86e894907d45e27ebab89e1ec7100e08d
2013-10-24 18:55:29 +09:00
David Pursehouse
8d2b4a0dc4 Correct Gerrit releases download link in installation documentation
The documentation refers to an outdated site that does not actually
have any of the release binaries any more.

Update it with a link to the current releases site.

Change-Id: I78bb7235f77cf02d41e438967cdc78b5814ce8ae
2013-10-18 11:03:17 +09:00
David Pursehouse
be28499d9f Document the autocompletion support for gerrit.sh and buck
Change-Id: I1cd5caef07bffb50348f0b5bd6240c47279c2441
2013-09-27 18:16:10 +09:00
Sasa Zivkov
e5fc90eb67 Optionally, initialize site from WebAppInitializer.
This supports automatic site initialization on Gerrit server startup
when Gerrit runs in a servlet container. Both creation of a new site
and upgrade of an existing site are supported.

This feature may be useful for such setups where Gerrit admins don't
have direct access to the database and the file system of the server
where Gerrit should be deployed and, therefore, cannot perform the
init from their local machine prior to deploying Gerrit on such a
server. It may also make deployment and testing in a local servlet
container faster to setup as the init step could be skipped.

The site initialization will be performed only if the 'gerrit.init'
system property exists (the value of the property is not, used only the
existence of the property matters).

If the 'gerrit.site_path' system property is defined then the init is
run for that site. The database connectivity, in that case, is defined
in the etc/gerrit.config.

If 'gerrit.site_path' is not defined then Gerrit will try to find an
existing site by looking into the system_config table in the database
defined via the 'jdbc/ReviewDb' JNDI property. If system_config table
exists then the site_path from that table is used for initialization.
Database connectivity is defined by the jdbc/ReviewDb JNDI property.

Finally, if neither 'gerrit.site_path' property nor the system_config
table exists, the 'gerrit.init_path' system property, if defined, will
be used to determine the site path. Database connectivity, also for this
case,is defined by the jdbc/ReviewDb JNDI property.

Example 1:
  Prepare Tomcat so that a site is initialized at a given path using
  the H2 database (if the site doesn't exist yet) or using whatever
  database is defined in the etc/gerrit.config of that site:

  $ export CATALINA_OPTS='-Dgerrit.init -Dgerrit.site_path=/path/to/site'
  $ catalina.sh start

Example 2:
  Prepare Tomcat so that an existing site with the path defined in the
  system_config table is initialized (upgraded) on Gerrit startup. The
  assumption is that the jdbc/ReviewDb JNDI property is defined in
  Tomcat:

  $ export CATALINA_OPTS='-Dgerrit.init'
  $ catalina.sh start

Example 3:
  Assuming the database schema doesn't exist in the database defined
  via the jdbc/ReviewDb JNDI property, initialize a new site using that
  database and a given path:

  $ export CATALINA_OPTS='-Dgerrit.init -Dgerrit.init_path=/path/to/site'
  $ catalina.sh start

Change-Id: Ic3e8c993087d2fbb38e14479a539dc62495ad908
2013-09-18 12:52:17 -07:00
David Pursehouse
3be717b274 Change "a SQL" to "an SQL"
Change-Id: I7521bd44e689a294433488db4a4ba4c9f310d20f
2013-05-13 16:50:33 +09:00
Dave Borowitz
1e49e143ec Allow projects to specify themes
Gerrit administrators can put per-project themes in
$site_path/themes/{project-name}; the same header/footer/CSS filenames
are supported as for sitewide themes. These are inherited and cached
per-project and exposed via GET /projects/X/config.

Themes must be provided by a site admin rather than arbitrary project
admins, so the site admins can be responsible for making sure themes
do not introduce XSS vulnerabilities.

Change-Id: I065d9e6d4df9275b963bb142ec11f66b5604678b
2013-04-10 10:47:03 -07:00
Kyle Laker
839edfca32 Documentation: Fix init.d symbolic link commands
Update the symbolic link commands to be absolute so they are more
universal in site setup. Additionally, fix the commands so that
the service is stopped/started with the proper name.

Change-Id: Ia426d5b087350db59e02b8bfc46e5a660644dccd
2013-03-08 12:12:18 -05:00
Jason Huntley
25bbd51d6e Separate the database setup instructions to a shared file
Separate the database setup instructions out into a shared file
so the same text can be included in the Tomcat install instructions
later.

Change-Id: I91dae81f8dc7ad361a40f7a76ec74ec69aaa4250
2012-11-28 16:54:10 +09:00
David Pursehouse
221d4f6250 Documentation: Various corrections
Correct typos, spelling mistakes, and grammatical errors.

Change-Id: I80ec66de7b2228f9ff45a2f06faf576707195758
2012-06-12 14:54:54 +02:00
Shawn O. Pearce
7d2cb04d07 Move replication logic to replication plugin
This splits all of the replication code out of the core server
and moves it into a standard plugin. A new listener API is used
inside of the core server to notify interested plugins of any Git
reference changes, which the replication code can hook into to
schedule its events.

Change-Id: I77ee4440a009c2ce1c62fb6a445c7e3c912245f9
2012-05-18 10:25:19 -07:00
Martin Fick
472bb9d4de Document how to install plugins
Change-Id: I65814d26b7eda93b6f660ddf4fc4b345a8c0aabb
2012-05-08 17:25:42 -07:00
Fredrik Luthander
a75dadcc0f Documentation: Introducing a quick and dirty setup tutorial
The new document covers quick installation, new project and first upload.
It contains lots of quoted output, with a demo style to it.

Change-Id: I9404376b527368a8348da507422c3912085e63d9
Signed-off-by: Fredrik Luthander <fredrik.luthander@sonyericsson.com>
2011-12-12 09:48:34 +01:00
Fredrik Luthander
833aa74569 Added additional information on the install instructions.
The installation instructions presumes much prior knowledge.
This is an attempt at making some of that knowledge less implicit.

Change-Id: I56195eedbe8c73248e2545a95f2237d16a1d54ed
2011-11-10 14:02:45 +01:00
Francois Marier
d550b46eb8 Documentation: rename "Apache 2 Reverse Proxy"
This will allow users of different web servers to contribute
instructions for non-Apache web daemons.

Change-Id: I94763a428c109c0106e7bef40da1179fa7284165
Signed-off-by: Francois Marier <francois@debian.org>
2011-04-13 14:30:20 +12:00
Karsten Dambekalns
a7f72a20d7 Adjust documentation source to current asciidoc version
This meant fixing old tables syntax, adjusting some overly long header
underlines and some other small issues.

Change-Id: I2701a5040d225454225034ed5ef7861580743707
2011-03-25 14:51:10 +01:00
Shawn O. Pearce
9f9701443b documentation: Link to apache2 reverse proxy setup
Change-Id: I89754da89020838d3f885a5819c034b0ee4d299b
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-12-16 11:36:59 -08:00
Shawn O. Pearce
9ad8ba528e documentation: Rewrite installation guide to use new init process
Now that installation is more or less just one command with a guided
interaction asking configuration questions we can start to simplify
the user guide.

Change-Id: Id98f9843d29e1fe0b445c2a714ace9ec3938ff79
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-12-12 20:26:30 -08:00
Shawn O. Pearce
e31d02c9cd documentation: Clean up references to 'Gerrit2'
Now that the 2.x code base is over a year old, and has been in
production for almost a full year, its time to stop calling this
'Gerrit2' and start referring to it by the complete project name,
Gerrit Code Review.

Change-Id: Ifb37dd63b94ed7e1b938511aa0fc2a6ad3c981d6
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-12-11 17:43:39 -08:00