noccy/php-hotfix
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Chris 2016-12-24 14:41:38 +01:00
parent 84f4e850f5
commit ab96d598fb
1 changed files with 19 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -13,7 +13,6 @@ heavy lifting for you, including dependencies.
$ chmod +x hotfix-installer.run
$ ./hotfix-installer.run
### Manual install
If you would like to install it manually:
@ -21,35 +20,33 @@ If you would like to install it manually:
$ curl -O ~/bin/hotfix http://files.noccy.com/hotfix/hotfix
$ chmod +x ~/bin/hotfix
## Using Hotfixes
### Security precautions
To use a hotfix, you need to have the publishers public key imported. For my hotfixes,
you need to do:
If you want to make sure that you are using an official build of the hotfix utility,
you should verify the hotfix executable using the NoccyLabs signing key. Make sure
you import the key as specified below, and then download the signature into the same
directory as the executable:
$ curl http://files.noccy.com/hotfix/signing-key.asc | gpg --import -
$ curl http://files.noccy.com/hotfix/hotfix.sig > hotfix.sig
$ gpg --verify hotfix.sig
Next, create a file at `~/.hotfix.conf` containing:
You should get output confirming a good signature.
[alias]
noccy=http://files.noccy.com/hotfix/{fix}.fix.signed
### How do I import the public key?
And finally, apply the desired hotfix:
$ curl http://files.noccy.com/hotfix/signing-key.gpg | gpg --import -
$ hotfix apply noccy:install-processing
## Available Hotfixes
### Processing
This will install the latest version of Processing into `/opt`.
Without a defined alias you would do:
$ hotfix apply http://files.noccy.com/hotfix/install-processing.fix.signed
### Spotify
This hotfix will enable the official Spotify debian repositories and install the Spotify client.
It is not compatible with any other distros at this time.
$ hotfix apply http://files.noccy.com/hotfix/install-spotify.fix.signed
## Publishing Hotfixes
1. Create your hotfix in a text editor. You can use one of the examples as a
starting point.
2. Test the fix locally, using `hotfix apply -I <file>` to make sure it works
as intended.
3. Once everything works as intended, sign the hotfix using `hotfix sign <file>`
and upload the `.fix.signed` file to your location of choice.
4. Put a link to your public key in your forum signature, on your about page etc.
5. Publish your fix together with the relevant information.