Template:Build Documentation Get Source

From Kicksecure
Jump to navigation Jump to search

FREE

Note: By proceeding, you acknowledge that you have read, understood and agreed to our Terms of Service and License Agreement.

1. Install git.

Click = Copy Copied to clipboard! sudo apt update && sudo apt install git

2. Get the source code including git submodules. [1] [2]

Note: Replace 17.2.8.5-stable with the actual tag you want to build.

Click = Copy Copied to clipboard! git clone --depth=1 --branch 17.2.8.5-stable --jobs=4 --recurse-submodules --shallow-submodules https://github.com/Kicksecure/derivative-maker.git

3. Check if above command succeeded.

If there have been errors such as: 

fatal: unable to access 'https://github.com/.../': Could not resolve host: github.com

Or. 

fatal: unable to access 'https://github.com/.../': gnutls_handshake() failed: The TLS connection was non-properly terminated.

Then the download probably failed.

Checking if the download failed or succeeded can be done by checking the exit code.

Choose your shell.

Zsh in Kicksecure or Derivatives

If the last line contains something such as the following. 

zsh: exit 1

Then do not proceed and see footnote. [3]

bash and other Shells

Show the exit code.

Click = Copy Copied to clipboard! echo $?

Output should show. 

0

If any other exit code is shown, do not proceed and see footnote. [3]

4. Done.

Git repository cloning has been completed.

Footnotes[edit]

  1. ↑ Optional git parameters:
    • --depth=1: Used to speed up the download.
    • --branch 17.2.8.5-stable: Usability. Used to speed up the download.
    • --jobs=4: Used to speed up the download.
    • --recurse-submodules --shallow-submodules: Usability.
    Knowledgeable git users are free to drop any of these optional parameters.
  2. ↑ Alternatively, this can be achieved with the following commands in several steps. This is useful if network issues arise.
    • Over HTTPS:
      • Click = Copy Copied to clipboard! git clone --depth=1 --branch 17.2.8.5-stable https://github.com/Kicksecure/derivative-maker.git
    • Over SSH.
      • Might work better over slow networks but requires a GitHub account and a configured SSH public key at GitHub. See footnote [A] below.
      • Click = Copy Copied to clipboard! git clone --depth=1 --branch 17.2.8.5-stable git@github.com:Kicksecure/derivative-maker.git
    Click = Copy Copied to clipboard! cd derivative-maker Click = Copy Copied to clipboard! git submodule update --init --recursive --progress --jobs=4

    [A] GitHub SSH public key setup.

    1. You need to create an SSH public key.

    Undocumented.

    2. You view your your SSH public key.

    Click = Copy Copied to clipboard! cat ~/.ssh/id_ed25519.pub

    3. Copy it.

    4. And paste your the SSH public key on GitHub.

    https://github.com/settings/keysarchive.org

  3. ↑ Jump up to: 3.0 3.1 Delete the derivative-maker source code folder and retry. 
    sudo rm -r derivative-maker
Your support makes
all the difference!

We believe security software like Kicksecure needs to remain Open Source and independent. Would you help sustain and grow the project? Learn more about our 12 year success story and maybe DONATE!

Retrieved from "https://www.kicksecure.com/w/index.php?title=Template:Build_Documentation_Get_Source&oldid=82262"