Skip to content

Commit c86a9ea

Browse files
committed
nextcloudPackages: edit README.md
1 parent 0354cb8 commit c86a9ea

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

pkgs/servers/nextcloud/packages/README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
= Adding apps =
1+
## Updating apps
2+
3+
To regenerate the nixpkgs nextcloudPackages set, run:
4+
5+
```
6+
./generate.sh
7+
```
8+
9+
After that you can commit and submit the changes in a pull request.
10+
11+
## Adding apps
12+
13+
**Before adding an app and making a pull request to nixpkgs, please first update as described above in a separate commit.**
214

315
To extend the nextcloudPackages set, add a new line to the corresponding json
416
file with the id of the app:
@@ -11,27 +23,29 @@ https://apps.nextcloud.com. The id corresponds to the last part in the app url,
1123
for example `breezedark` for the app with the url
1224
`https://apps.nextcloud.com/apps/breezedark`.
1325

14-
To regenerate the nixpkgs nextcloudPackages set, run:
26+
Then regenerate the nixpkgs nextcloudPackages set by running:
1527

1628
```
1729
./generate.sh
1830
```
1931

20-
After that you can commit and submit the changes.
32+
**Make sure that in this update, only the app added to `nextcloud-apps.json` gets updated.**
33+
34+
After that you can commit and submit the changes in a pull request.
2135

22-
= Usage with the Nextcloud module =
36+
## Usage with the Nextcloud module
2337

24-
The apps will be available in the namespace `nextcloud25Packages.apps`.
38+
The apps will be available in the namespace `nextcloud31Packages.apps` (and for older versions of Nextcloud similarly).
2539
Using it together with the Nextcloud module could look like this:
2640

27-
```nix
41+
```
2842
{
2943
services.nextcloud = {
3044
enable = true;
31-
package = pkgs.nextcloud25;
45+
package = pkgs.nextcloud31;
3246
hostName = "localhost";
3347
config.adminpassFile = "${pkgs.writeText "adminpass" "hunter2"}";
34-
extraApps = with pkgs.nextcloud25Packages.apps; {
48+
extraApps = with pkgs.nextcloud31Packages.apps; {
3549
inherit mail calendar contact;
3650
};
3751
extraAppsEnable = true;

0 commit comments

Comments
 (0)