-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4ad99ed
commit 307d871
Showing
2 changed files
with
21 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,20 @@ | ||
# Setup process | ||
|
||
1. User specifies a data repository URL, which is then cloned. | ||
2. If the repo is empty, some default data is configured: | ||
* `config.json` with the site's default configuration | ||
* `.gitignore` with a simple gitignore to ignore the local configuration | ||
3. Otherwise, the `.gitignore` is checked to ensure that `config.local.json` | ||
will be ignored (lest auth information be leaked). | ||
4. A secure password is generated, and stored securely in `config.local.json`. | ||
It is shown to the user once, and they are prompted to take note of it. | ||
|
||
The site is then fully configured. | ||
## 1. Account creation | ||
|
||
The user creates the initial account, which triggers the private data setup. | ||
|
||
## 2. Data initialization | ||
|
||
The user then chooses how to initialize the repo: | ||
|
||
* From a `git` repo. The repo is cloned. | ||
* Empty, meaning a new blank repository is created. | ||
|
||
The user is also given the options to control how the server uses SSH keys. | ||
Allowed options are: | ||
|
||
* Generate an SSH key-pair, stored within the private data. | ||
* Use an existing private key given its path. | ||
* Use the default SSH identity, which works best if the app is running on an | ||
account with existing SSH access. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters