This is the build script for all of the GeoFS extensions.
First, install the the gefs-build-script package (in this directory):
npm install -g .
Make sure your project has a gefs-build-config.toml file in the root
directory. Possible options are shown below (default options are
commented out):
# The name to use for descriptions.
name = "Example Extension"
# The variable name through which the extension is accessible.
globalVariableName = "example_ext"
# The prefix given to the zip file package.
shortName = "example"
# A file called "[name].crx" will be created inside the package.
crxName = "gefs_example_setup"
# The license comment to include in the generated .user.js file.
licenseComment = """
Copyright (c) Karl Cheng 2016
Licensed under the GNU General Public Licence, version 3 or later.
See the LICENSE file for details."""
[requirejs]
# The folder containing the modules for the extension. (default)
# baseUrl = "source"
# The module name of the main file, relative to baseUrl. (default)
# name = "init"
Once you have created the file, run the build script (in the root directory of your project):
gefs-build-script --pem YOUR_PEM_FILE.pem [--debug]
Note that there must be a "userscript.js" and a "README.md" file in the
baseUrl directory.
If you do not already have a PEM file, create one using openssl:
openssl genrsa 2048 | openssl pkcs8 -topk8 -nocrypt -out key.pem
Warning: for security reasons, the PEM file MUST be kept private. Do not upload it online, commit/push it to GitHub or any other repository, or give it to anyone else.
If you'd like to contribute to this project, follow the instructions
given in the file CONTRIBUTING.md.
Copyright (c) 2016-18 Karl Cheng
Email: <qantas94heavy@gmail.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.