Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kschu91 committed Feb 20, 2017
1 parent 8622ab5 commit d9b014b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,17 @@ Have a look at the [prerequisites documentation of Gogs](https://gogs.io/docs/in
### Beginning with gogs

You can simply include the `gogs` module to get started with the defaults. Check out the [reference](#reference) to see what the defaults are.
After that you can visit your installation via [http://youhost.tld:3000](http://youhost.tld:3000) and you can follow the installation instructions.

include ::gogs


## Usage

The most common way of using the `gogs` module with a custom configuration is the following.
The most common way of using the `gogs` module with a minimal set of custom configuration is the following.
> **Note**: You are able to provide any available Gogs configuration in `app_ini` and `app_ini_sections`. For a
complete list of available configuration have a look at the [Gogs configuration cheat sheet](https://gogs.io/docs/advanced/configuration_cheat_sheet).

class { '::gogs':
app_ini => {
'APP_NAME' => 'My Fancy GIT Service'
Expand All @@ -66,10 +67,16 @@ complete list of available configuration have a look at the [Gogs configuration
},
'security' => {
'SECRET_KEY' => 'mysecretkey',
}
},
'security' => {
'INSTALL_LOCK' => true,
},
},
}

> **Note**: Currently the module will not create an admin user for you. You can do this by using the gogs cli:
`gogs admin create-user --name="john.doe" --password="supersecret" --email="[email protected]" --admin`

## Reference

### Parameters
Expand Down
4 changes: 2 additions & 2 deletions manifests/params.pp
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
'server' => {
'DOMAIN' => 'localhost',
'ROOT_URL' => 'http://localhost:3000',
'HTTP_ADDR' => 'localhost',
'HTTP_ADDR' => '0.0.0.0',
'HTTP_PORT' => 3000,
},
'repository' => {
'ROOT' => $repository_root,
},
'security' => {
'INSTALL_LOCK' => true,
'INSTALL_LOCK' => false,
},
}

Expand Down

0 comments on commit d9b014b

Please sign in to comment.