Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gary-kim/nc-build-script

My personal build script for use with Nextcloud. (Unsupported) (Unaffiliated with Nextcloud GmbH)
https://github.com/gary-kim/nc-build-script

hacktoberfest nextcloud

Last synced: 16 days ago
JSON representation

My personal build script for use with Nextcloud. (Unsupported) (Unaffiliated with Nextcloud GmbH)

Awesome Lists containing this project

README 

        
# Build Script for Use with Nextcloud



[![Build Status](https://ghdrone.garykim.dev/api/badges/gary-kim/nc-build-script/status.svg)](https://ghdrone.garykim.dev/gary-kim/nc-build-script)



**This script and repo is unaffiliated with Nextcloud GmbH**



**If you are running Nextcloud for a large enterprise, consider getting a subscription with [Nextcloud GmbH](https://nextcloud.com/enterprise/) to get the supported version.**



**Normal users are also probably better served by the builds created by Nextcloud GmbH. Those can be downloaded [here](https://nextcloud.com/install/).**



This is a build script for use with Nextcloud.



This script does not include signing or actually releasing a build.



If you encounter any issues while using the output of this script, make sure the issue is reproducible in [Nextcloud GmbH releases](https://download.nextcloud.com/server/releases/) before making a new issue in the Nextcloud issue tracker. If it cannot be reproduced, open an issue in this repo instead.



You likely cannot call the output of this script Nextcloud and will have to change the name as *Nextcloud* is a registered trademark of Nextcloud GmbH.



### How to Run



**Requires Node v12 or later**



```bash

npm ci

npm start -- --help

npm start -- build



# Build v17.0.4

npm start -- build --nc-version v17.0.4

```



You can find a list of currently supported Nextcloud build versions in the [configs](configs) directory.



### Custom Config



If you'd like to make a custom config, copy the version you'd like from the [configs](configs) directory then make the desired modifications to that file.

Once you've made those modifications, run the script with that config by running `npm start -- build --custom-config `.



### Currently Missing



List of things in the Nextcloud GmbH release that are not in releases made by this script.



* Documentation

    * The Nextcloud GmbH release contains documentation from .

    * Planned

* Signing

    * Nextcloud GmbH's release script signs all apps and the release itself.

    * Planned (provide your own keys. Obviously not possible to sign things such that it would pass on currently running Nextcloud instances (that'd defeat the whole point of signing))

* Support app

    * The support app is currently only in a private repo so is not publicly available so cannot be included in these releases. Strictly speaking, it could be pulled out of the official release and repackaged as the `appinfo/info.xml` indicates that it is `agpl` licensed and the entirety of Nextcloud including the releases by Nextcloud GmbH are licensed under `AGPL-3.0-or-later` but the point of this script is to be able to generate releases without having to use the Nextcloud GmbH releases.

* Exclude list different

    * The exact exclude list used is different so some files that are in the Nextcloud GmbH release are excluded in this release. Things such as extra test files are unnecessary but in the Nextcloud GmbH release are removed in this script.



### To do



* Complete everything possible in [Currently Missing](#currently-missing)

* Document how to create new release configs

* Write contributing documentation



### License



Licensed under [AGPL-3.0-or-later](LICENSE).



This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.



Copyright © 2020 Gary Kim <>