Reorganize install instructions across multiple help files

I've also improved the install instructions based on what actually works when
deploying the GitHub-hosted version of the codebase to App Engine using an
external cloud account.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=135390967
This commit is contained in:
mcilwain 2016-10-06 12:34:43 -07:00 committed by Ben McIlwain
parent 940fadff8a
commit 30adfd28fc
5 changed files with 340 additions and 254 deletions

View file

@ -5,8 +5,21 @@ working registry system up and running. Broadly speaking, configuration works in
two ways -- globally, for the entire sytem, and per-TLD. Global configuration is
managed by editing code and deploying a new version, whereas per-TLD
configuration is data that lives in Datastore in `Registry` entities, and is
updated by running `nomulus` commands without having to deploy a new
version.
updated by running `nomulus` commands without having to deploy a new version.
[TOC]
## Initial configuration
Here's a checklist of things that need to be configured upon initial
installation of the project:
* Create Google Cloud Storage buckets (see the [App Engine architecture
guide](./app-engine-architecture.md)).
* Modify `ConfigModule.java` and set project-specific settings such as product
name (see below).
* Copy and edit `ProductionRegistryConfigExample.java` with your
project-specific settings (see below).
## Environments
@ -116,10 +129,10 @@ to provide from `Keyring`, and you can see examples of them in action in
configuration. They contain any kind of configuration that is specific to a TLD,
such as the create/renew price of a domain name, the pricing engine
implementation, the DNS writer implementation, whether escrow exports are
enabled, the default currency, the reserved label lists, and more. The
`nomulus update_tld` command is used to set all of these options. See
the [admin tool documentation](./admin-tool.md) for more information, as well as
the command-line help for the `update_tld` command. Unlike global configuration
enabled, the default currency, the reserved label lists, and more. The `nomulus
update_tld` command is used to set all of these options. See the [admin tool
documentation](./admin-tool.md) for more information, as well as the
command-line help for the `update_tld` command. Unlike global configuration
above, per-TLD configuration options are stored as data in the running system,
and thus do not require code pushes to update.