-
Notifications
You must be signed in to change notification settings - Fork 7
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
Showing
2 changed files
with
12 additions
and
5 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 |
---|---|---|
|
@@ -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' | ||
|
@@ -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 | ||
|
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