From d20b036ac7db086af89a1c07f329a49e03b6455c Mon Sep 17 00:00:00 2001 From: kasenvr <52365539+kasenvr@users.noreply.github.com> Date: Wed, 2 Dec 2020 22:52:42 -0500 Subject: [PATCH 01/14] Add basic Linux server packaging instructions. --- INSTALL.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 64 insertions(+), 11 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 994725ac28..a0966e3fc5 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ # Creating an Installer -*Last Updated on August 24, 2020* +*Last Updated on December 2, 2020* Follow the [build guide](BUILD.md) to figure out how to build Vircadia for your platform. @@ -9,13 +9,13 @@ During generation, CMake should produce an `install` target and a `package` targ The `install` target will copy the Vircadia targets and their dependencies to your `CMAKE_INSTALL_PREFIX`. This variable is set by the `project(hifi)` command in `CMakeLists.txt` to `C:/Program Files/hifi` and stored in `build/CMakeCache.txt` -### Packaging +## Packaging To produce an installer, run the `package` target. However you will want to follow the steps specific to your platform below. -#### Windows +### Windows -##### Prerequisites +#### Prerequisites To produce an executable installer on Windows, the following are required: @@ -63,11 +63,11 @@ To produce an executable installer on Windows, the following are required: 1. [Node.JS and NPM]() 1. Install version 10.15.0 LTS -##### Code Signing (optional) +#### Code Signing (optional) For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PASSPHRASE` environment variables to be present during CMake runtime and globally as we proceed to package the installer. -##### Creating the Installer +#### Creating the Installer 1. Perform a clean cmake from a new terminal. 1. Open the `vircadia.sln` solution with elevated (administrator) permissions on Visual Studio and select the **Release** configuration. @@ -79,7 +79,14 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS 1. Build CMakeTargets->PACKAGE The installer is now available in `build\_CPack_Packages\win64\NSIS` -#### OS X +#### FAQ + +1. **Problem:** Failure to open a file. ```File: failed opening file "\FOLDERSHARE\XYZSRelease\...\Credits.rtf" Error in script "C:\TFS\XYZProject\Releases\NullsoftInstaller\XYZWin7Installer.nsi" on line 77 -- aborting creation process``` + 1. **Cause:** The complete path (current directory + relative path) has to be < 260 characters to any of the relevant files. + 1. **Solution:** Move your build and packaging folder as high up in the drive as possible to prevent an overage. + +### OS X + 1. [npm]() Install version 12.16.3 LTS @@ -91,8 +98,54 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS 1. Perform a Release build of `package` Installer is now available in `build/_CPack_Packages/Darwin/DragNDrop -### FAQ +### Linux -1. **Problem:** Failure to open a file. ```File: failed opening file "\FOLDERSHARE\XYZSRelease\...\Credits.rtf" Error in script "C:\TFS\XYZProject\Releases\NullsoftInstaller\XYZWin7Installer.nsi" on line 77 -- aborting creation process``` - 1. **Cause:** The complete path (current directory + relative path) has to be < 260 characters to any of the relevant files. - 1. **Solution:** Move your build and packaging folder as high up in the drive as possible to prevent an overage. +#### Server + +##### Ubuntu | .deb + +1. Ensure you are using an Ubuntu 18.04 system. +1. Set up Vircadia Builder to compile the server. + ``` + git clone https://github.com/kasenvr/vircadia-builder.git + cd vircadia-builder + chmod +x vircadia-builder + ./vircadia-builder + ``` +1. Build the server. + ``` + ./vircadia-builder --build server + ``` +1. Navigate to the `pkg-scripts` directory. + ``` + cd ../Vircadia/source/pkg-scripts/ + ``` +1. Generate the .deb package. + ``` + DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server + ``` +1. If successful, the generated .deb package will be in the `pkg-scripts` folder. + +##### Amazon Linux 2 | .rpm + +1. Ensure you are using an Amazon Linux 2 system. +1. Set up Vircadia Builder to compile the server. + ``` + git clone https://github.com/kasenvr/vircadia-builder.git + cd vircadia-builder + chmod +x vircadia-builder + ./vircadia-builder + ``` +1. Build the server. + ``` + ./vircadia-builder --build server + ``` +1. Navigate to the `pkg-scripts` directory. + ``` + cd ../Vircadia/source/pkg-scripts/ + ``` +1. Generate the .rpm package. + ``` + ./make-rpm-server + ``` +1. If successful, the generated .rpm package will be in the `pkg-scripts` folder. From 0ab82f686340fb0f1a5ea55fdb49ee8d0a584f99 Mon Sep 17 00:00:00 2001 From: Kalila L Date: Mon, 21 Dec 2020 04:24:01 -0500 Subject: [PATCH 02/14] Add examples to env variables. --- BUILD.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/BUILD.md b/BUILD.md index 2d94d1b5b1..9b31c4895b 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,6 +1,6 @@ # General Build Information -*Last Updated on August 26, 2020* +*Last Updated on December 21, 2020* ### OS Specific Build Guides @@ -11,7 +11,7 @@ ### Dependencies - [git](https://git-scm.com/downloads): >= 1.6 -- [cmake](https://cmake.org/download/): 3.9 +- [CMake](https://cmake.org/download/): 3.9 - [Python](https://www.python.org/downloads/): 3.6 or higher - [Node.JS](https://nodejs.org/en/): >= 12.13.1 LTS - Used to build the Screen Sharing executable. @@ -41,6 +41,7 @@ These are not placed in your normal build tree when doing an out of source build Vircadia uses CMake to generate build files and project files for your platform. #### Qt + CMake will download Qt 5.12.3 using vcpkg. To override this (i.e. use an installed Qt configuration - you will need to set a QT_CMAKE_PREFIX_PATH environment variable pointing to your Qt **lib/cmake** folder. @@ -72,9 +73,9 @@ Where /path/to/directory is the path to a directory where you wish the build fil // The identifying tag of the release. CMAKE_BACKTRACE_TOKEN - // The release version. + // The release version. (e.g. 2021.4.2-Osiris) RELEASE_NUMBER - // The build commit. + // Typically, this is the build commit short hash. (e.g. f1576ab) BUILD_NUMBER // The type of release. @@ -108,7 +109,7 @@ If CMake gives you the same error message repeatedly after the build fails, try ##### Generating a release/debug only vcpkg build -In order to generate a release or debug only vcpkg package, you could use the use the `VCPKG_BUILD_TYPE` define in your cmake generate command. Building a release only vcpkg can drastically decrease the total build time. +In order to generate a release or debug only vcpkg package, you could use the use the `VCPKG_BUILD_TYPE` define in your CMake generate command. Building a release only vcpkg can drastically decrease the total build time. For release only vcpkg: From 87b94c8b14b86fbbbd00d12e39acec180ca2c7ad Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Sun, 21 Feb 2021 17:25:06 -0500 Subject: [PATCH 03/14] Update INSTALL.md --- INSTALL.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index a0966e3fc5..5abd7e8e2c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ # Creating an Installer -*Last Updated on December 2, 2020* +*Last Updated on February 21, 2021* Follow the [build guide](BUILD.md) to figure out how to build Vircadia for your platform. @@ -105,47 +105,60 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ##### Ubuntu | .deb 1. Ensure you are using an Ubuntu 18.04 system. -1. Set up Vircadia Builder to compile the server. +2. Get and bootstrap Vircadia Builder. ``` - git clone https://github.com/kasenvr/vircadia-builder.git + git clone https://github.com/vircadia/vircadia-builder.git cd vircadia-builder chmod +x vircadia-builder - ./vircadia-builder ``` -1. Build the server. +3. Set up Vircadia Builder to compile the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. ``` ./vircadia-builder --build server ``` -1. Navigate to the `pkg-scripts` directory. +4. Build the server. + ``` + ./vircadia-builder --build server + ``` +5. Navigate to the `pkg-scripts` directory. ``` cd ../Vircadia/source/pkg-scripts/ ``` -1. Generate the .deb package. +6. Generate the .deb package. ``` DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server ``` -1. If successful, the generated .deb package will be in the `pkg-scripts` folder. +7. If successful, the generated .deb package will be in the `pkg-scripts` folder. ##### Amazon Linux 2 | .rpm 1. Ensure you are using an Amazon Linux 2 system. -1. Set up Vircadia Builder to compile the server. +2. Update the system and install dependencies. ``` - git clone https://github.com/kasenvr/vircadia-builder.git + sudo yum update -y + sudo yum install git -y + sudo yum install rpm-build + ``` +3. Get and bootstrap Vircadia Builder. + ``` + git clone https://github.com/vircadia/vircadia-builder.git cd vircadia-builder + sudo ./install_amazon_linux_deps.sh chmod +x vircadia-builder - ./vircadia-builder ``` -1. Build the server. +4. Set up Vircadia Builder to compile the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. ``` ./vircadia-builder --build server ``` -1. Navigate to the `pkg-scripts` directory. +5. Build the server. + ``` + ./vircadia-builder --build server + ``` +6. Navigate to the `pkg-scripts` directory. ``` cd ../Vircadia/source/pkg-scripts/ ``` -1. Generate the .rpm package. +7. Generate the .rpm package. ``` ./make-rpm-server ``` -1. If successful, the generated .rpm package will be in the `pkg-scripts` folder. +8. If successful, the generated .rpm package will be in the `pkg-scripts` folder. From 94192a5657357c923aa1a8bda969476924cc32f3 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Sun, 21 Feb 2021 19:45:14 -0500 Subject: [PATCH 04/14] Update INSTALL.md --- INSTALL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 5abd7e8e2c..403605bdc8 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -125,7 +125,7 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ``` 6. Generate the .deb package. ``` - DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server + DEBVERSION="Semver e.g. 2021.1.0" DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server ``` 7. If successful, the generated .deb package will be in the `pkg-scripts` folder. @@ -159,6 +159,6 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ``` 7. Generate the .rpm package. ``` - ./make-rpm-server + RPMVERSION="Semver e.g. 2021.1.0" ./make-rpm-server ``` 8. If successful, the generated .rpm package will be in the `pkg-scripts` folder. From 82436b6f333b6eca13da9807af66510a42bb4dae Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Mon, 22 Feb 2021 03:14:22 -0500 Subject: [PATCH 05/14] Update INSTALL.md --- INSTALL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 403605bdc8..6f58ec7b81 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -123,7 +123,7 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ``` cd ../Vircadia/source/pkg-scripts/ ``` -6. Generate the .deb package. +6. Generate the .deb package. Set `DEBVERSION` to a valid semantic version value e.g. "2021.1.0". ``` DEBVERSION="Semver e.g. 2021.1.0" DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server ``` @@ -157,7 +157,7 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ``` cd ../Vircadia/source/pkg-scripts/ ``` -7. Generate the .rpm package. +7. Generate the .rpm package. Set `RPMVERSION` to a valid semantic version value e.g. "2021.1.0". ``` RPMVERSION="Semver e.g. 2021.1.0" ./make-rpm-server ``` From 0693fcbf60a74d022d99422d91806dce5675f1a0 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:55:09 -0500 Subject: [PATCH 06/14] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Julian Groß --- INSTALLER.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/INSTALLER.md b/INSTALLER.md index a96af042b5..0fdbb028f3 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -102,7 +102,7 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS #### Server -##### Ubuntu | .deb +##### Ubuntu 18.04 | .deb 1. Ensure you are using an Ubuntu 18.04 system. 2. Get and bootstrap Vircadia Builder. @@ -111,11 +111,11 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS cd vircadia-builder chmod +x vircadia-builder ``` -3. Set up Vircadia Builder to compile the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. +3. Run Vircadia Builder to build the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. ``` ./vircadia-builder --build server ``` -4. Build the server. +4. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. ``` ./vircadia-builder --build server ``` @@ -145,11 +145,11 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS sudo ./install_amazon_linux_deps.sh chmod +x vircadia-builder ``` -4. Set up Vircadia Builder to compile the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. +4. Run Vircadia Builder to build the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. ``` ./vircadia-builder --build server ``` -5. Build the server. +5. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. ``` ./vircadia-builder --build server ``` From 138e8a0007139341868efc15c36a7afaf5ed1cb6 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Mon, 1 Mar 2021 19:05:39 -0500 Subject: [PATCH 07/14] Update INSTALLER.md --- INSTALLER.md | 120 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 106 insertions(+), 14 deletions(-) diff --git a/INSTALLER.md b/INSTALLER.md index 0fdbb028f3..bcbd24a6c0 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -104,8 +104,13 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ##### Ubuntu 18.04 | .deb -1. Ensure you are using an Ubuntu 18.04 system. -2. Get and bootstrap Vircadia Builder. +1. Ensure you are using an Ubuntu 18.04 system, here are the recommended specs: + ``` + AWS EC2 Instance Type: C5a.4xlarge + CPU Cores: 16 + Minimum Disk Space: 40GB + ``` +3. Get and bootstrap Vircadia Builder. ``` git clone https://github.com/vircadia/vircadia-builder.git cd vircadia-builder @@ -115,23 +120,69 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ``` ./vircadia-builder --build server ``` -4. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. +4. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. Otherwise, skip to the next step. ``` ./vircadia-builder --build server ``` -5. Navigate to the `pkg-scripts` directory. +5. Vircadia Builder will ask you to configure it to build the server. The values will be prefilled with defaults, the following steps will explain what they are and what you might want to put. *Advanced users: See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings.* +6. This value is the Git repository of Vircadia. You can set this URL to your fork of the Vircadia repository if you need to. + ``` + Git repository: https://github.com/vircadia/vircadia/ + # OR, for example + Git repository: https://github.com/digisomni/vircadia/ + ``` +7. This value is the tag on the repository. If you would like to use a specific version of Vircadia, typically tags will be named like this: "v2021.1.0-rc" + ``` + Git tag: master + # OR, for example + Git tag: v2021.1.0-rc + ``` +8. This value is the release type. For example, the options are `production`, `pr`, or `dev`. If you are making a build for yourself and others to use then use `production`. + ``` + Release type: DEV + # OR, for example we recommend you use + Release type: PRODUCTION + ``` +9. This value is the release version. Release numbers should be in a format of `YEAR-MAJORVERSION-MINORVERSION` which might look like this: `2021.1.0`. + ``` + Release number: 2021.1.0 + ``` +10. This value is the build number. We typically use the hash of the most recent commit on that Git tag which might look like this: `fd6973b`. + ``` + Build number: fd6973b + ``` +11. This value is the directory that Vircadia will get installed to. You should leave this as the default value unless you are an advanced user. + ``` + Installation dir: /home/ubuntu/Vircadia + ``` +12. This value is the number of CPU cores that the Vircadia Builder will use to compile the Vircadia server. By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. + ``` + CPU cores to use for Vircadia: 16 + ``` +13. This value is the number of CPU cores that the Vircadia Builder will use to compile Qt5 (a required component for Vircadia). By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. + ``` + CPU cores to use for Qt5: 16 + ``` +14. It will ask you if you would like to proceed with the specified values. If you're happy with the configuration, type `yes`, otherwise enter `no` and press enter to start over. You can press `Ctrl` + `C` simultaneously on your keyboard to exit. +15. Vircadia Builder will now run, it may take a while. See this [table](https://github.com/vircadia/vircadia-builder#how-long-does-it-take) for estimated times. +16. Navigate to the `pkg-scripts` directory. ``` cd ../Vircadia/source/pkg-scripts/ ``` -6. Generate the .deb package. Set `DEBVERSION` to a valid semantic version value e.g. "2021.1.0". +17. Generate the .rpm package. Set `RPMVERSION` to the same version you entered for the `Release number` on Vircadia Builder. *Advanced users: the version cannot begin with a letter and cannot include underscores or dashes in it.* ``` - DEBVERSION="Semver e.g. 2021.1.0" DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server + DEBVERSION="2021.1.0" DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server ``` -7. If successful, the generated .deb package will be in the `pkg-scripts` folder. +18. If successful, the generated .deb package will be in the `pkg-scripts` folder. ##### Amazon Linux 2 | .rpm -1. Ensure you are using an Amazon Linux 2 system. +1. Ensure you are using an Amazon Linux 2 system, here are the recommended specs: + ``` + AWS EC2 Instance Type: C5a.4xlarge + CPU Cores: 16 + Minimum Disk Space: 40GB + ``` 2. Update the system and install dependencies. ``` sudo yum update -y @@ -145,20 +196,61 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS sudo ./install_amazon_linux_deps.sh chmod +x vircadia-builder ``` -4. Run Vircadia Builder to build the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. +4. Run Vircadia Builder to build the server. ``` ./vircadia-builder --build server ``` -5. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. +5. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. Otherwise, skip to the next step. ``` ./vircadia-builder --build server ``` -6. Navigate to the `pkg-scripts` directory. +6. Vircadia Builder will ask you to configure it to build the server. The values will be prefilled with defaults, the following steps will explain what they are and what you might want to put. *Advanced users: See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings.* +7. This value is the Git repository of Vircadia. You can set this URL to your fork of the Vircadia repository if you need to. + ``` + Git repository: https://github.com/vircadia/vircadia/ + # OR, for example + Git repository: https://github.com/digisomni/vircadia/ + ``` +8. This value is the tag on the repository. If you would like to use a specific version of Vircadia, typically tags will be named like this: "v2021.1.0-rc". + ``` + Git tag: master + # OR, for example + Git tag: v2021.1.0-rc + ``` +9. This value is the release type. For example, the options are `production`, `pr`, or `dev`. If you are making a build for yourself and others to use then use `production`. + ``` + Release type: DEV + # OR, for example we recommend you use + Release type: PRODUCTION + ``` +10. This value is the release version. Release numbers typically should be in a format of `YEAR-MAJORVERSION-MINORVERSION` which might look like this: `2021.1.0`. + ``` + Release number: 2021.1.0 + ``` +11. This value is the build number. We typically use the hash of the most recent commit on that Git tag which might look like this: `fd6973b`. + ``` + Build number: fd6973b + ``` +12. This value is the directory that Vircadia will get installed to. You should leave this as the default value unless you are an advanced user. + ``` + Installation dir: /root/Vircadia + ``` +13. This value is the number of CPU cores that the Vircadia Builder will use to compile the Vircadia server. By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. + ``` + CPU cores to use for Vircadia: 16 + ``` +14. This value is the number of CPU cores that the Vircadia Builder will use to compile Qt5 (a required component for Vircadia). By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. + ``` + CPU cores to use for Qt5: 16 + ``` +15. It will ask you if you would like to proceed with the specified values. If you're happy with the configuration, type `yes`, otherwise enter `no` and press enter to start over. You can press `Ctrl` + `C` simultaneously on your keyboard to exit. +16. Vircadia Builder will now run, it may take a while. See this [table](https://github.com/vircadia/vircadia-builder#how-long-does-it-take) for estimated times. +17. Navigate to the `pkg-scripts` directory. ``` cd ../Vircadia/source/pkg-scripts/ ``` -7. Generate the .rpm package. Set `RPMVERSION` to a valid semantic version value e.g. "2021.1.0". +18. Generate the .rpm package. Set `RPMVERSION` to the same version you entered for the `Release number` on Vircadia Builder. *Advanced users: the version cannot begin with a letter and cannot include underscores or dashes in it.* ``` - RPMVERSION="Semver e.g. 2021.1.0" ./make-rpm-server + RPMVERSION="2021.1.0" ./make-rpm-server ``` -8. If successful, the generated .rpm package will be in the `pkg-scripts` folder. +19. If successful, the generated .rpm package will be in the `pkg-scripts` folder of the Vircadia source files. From 945e9bb9e95df965f22ae3f90892f10414a05cde Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Mon, 1 Mar 2021 19:07:05 -0500 Subject: [PATCH 08/14] Update INSTALLER.md --- INSTALLER.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALLER.md b/INSTALLER.md index bcbd24a6c0..efde9261bd 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -1,6 +1,6 @@ # Creating an Installer -*Last Updated on February 21, 2021* +*Last Updated on March 1, 2021* Follow the [build guide](BUILD.md) to figure out how to build Vircadia for your platform. From 13fd2b43d7fc35976cea1e8a924e593341857c3b Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Wed, 3 Mar 2021 01:50:14 -0500 Subject: [PATCH 09/14] Update INSTALLER.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Julian Groß --- INSTALLER.md | 1 - 1 file changed, 1 deletion(-) diff --git a/INSTALLER.md b/INSTALLER.md index efde9261bd..79c53b93d7 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -194,7 +194,6 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS git clone https://github.com/vircadia/vircadia-builder.git cd vircadia-builder sudo ./install_amazon_linux_deps.sh - chmod +x vircadia-builder ``` 4. Run Vircadia Builder to build the server. ``` From 8c9a80645560a7a80681e7a7ab3ab1ec52413430 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Wed, 3 Mar 2021 01:51:59 -0500 Subject: [PATCH 10/14] Update INSTALLER.md --- INSTALLER.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/INSTALLER.md b/INSTALLER.md index 79c53b93d7..183780d95f 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -114,9 +114,8 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ``` git clone https://github.com/vircadia/vircadia-builder.git cd vircadia-builder - chmod +x vircadia-builder ``` -3. Run Vircadia Builder to build the server. See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings. +3. Run Vircadia Builder. ``` ./vircadia-builder --build server ``` @@ -195,7 +194,7 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS cd vircadia-builder sudo ./install_amazon_linux_deps.sh ``` -4. Run Vircadia Builder to build the server. +4. Run Vircadia Builder. ``` ./vircadia-builder --build server ``` From 99fde1efd03c3abbf80693ff4177635bee94dc86 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Wed, 3 Mar 2021 21:31:05 -0500 Subject: [PATCH 11/14] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Julian Groß --- INSTALLER.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/INSTALLER.md b/INSTALLER.md index 183780d95f..07325f50bb 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -233,11 +233,11 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ``` Installation dir: /root/Vircadia ``` -13. This value is the number of CPU cores that the Vircadia Builder will use to compile the Vircadia server. By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. +13. This value is the number of CPU cores that the Vircadia Builder will use to compile the Vircadia server. By default it will use all cores available on your build server given you have enough memory. You should leave this as the default value it gives you for your build server. ``` CPU cores to use for Vircadia: 16 ``` -14. This value is the number of CPU cores that the Vircadia Builder will use to compile Qt5 (a required component for Vircadia). By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. +14. This value is the number of CPU cores that the Vircadia Builder will use to compile Qt5 (a required component for Vircadia). By default it will use all cores available on your build server given you have enough memory. You should leave this as the default value it gives you for your build server. ``` CPU cores to use for Qt5: 16 ``` From 2891d731b8108865afe8078772f860e498bcf909 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Wed, 3 Mar 2021 21:46:28 -0500 Subject: [PATCH 12/14] Update INSTALLER.md --- INSTALLER.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/INSTALLER.md b/INSTALLER.md index 07325f50bb..4bdf4410b3 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -104,10 +104,10 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ##### Ubuntu 18.04 | .deb -1. Ensure you are using an Ubuntu 18.04 system, here are the recommended specs: +1. Ensure you are using an Ubuntu 18.04 system. ``` - AWS EC2 Instance Type: C5a.4xlarge - CPU Cores: 16 + Minimum CPU Cores: 4 + Recommended CPU Cores: 16 Minimum Disk Space: 40GB ``` 3. Get and bootstrap Vircadia Builder. @@ -176,10 +176,10 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ##### Amazon Linux 2 | .rpm -1. Ensure you are using an Amazon Linux 2 system, here are the recommended specs: +1. Ensure you are using an Amazon Linux 2 system. You will need many CPU cores to complete this process within a reasonable time. As an alternative to AWS EC2, you may use a [virtual machine](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/amazon-linux-2-virtual-machine.html). Here are the recommended specs: ``` AWS EC2 Instance Type: C5a.4xlarge - CPU Cores: 16 + Recommended CPU Cores: 16 Minimum Disk Space: 40GB ``` 2. Update the system and install dependencies. From c3ea217d2d51b35c1798d0652d97e013b5768410 Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Thu, 4 Mar 2021 16:53:54 -0500 Subject: [PATCH 13/14] Update INSTALLER.md --- INSTALLER.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/INSTALLER.md b/INSTALLER.md index 4bdf4410b3..813f9986da 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -104,9 +104,8 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ##### Ubuntu 18.04 | .deb -1. Ensure you are using an Ubuntu 18.04 system. +1. Ensure you are using an Ubuntu 18.04 system. There is no required minimum to the amount of CPU cores needed, however it's recommended that you use as many as you have available in order to have an efficient experience. ``` - Minimum CPU Cores: 4 Recommended CPU Cores: 16 Minimum Disk Space: 40GB ``` From 193baeabf5e627c6c3be871f53a644a69fa8627b Mon Sep 17 00:00:00 2001 From: Kalila <69767640+digisomni@users.noreply.github.com> Date: Thu, 4 Mar 2021 16:55:18 -0500 Subject: [PATCH 14/14] Update INSTALLER.md --- INSTALLER.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALLER.md b/INSTALLER.md index 813f9986da..4f6ebc174d 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -1,6 +1,6 @@ # Creating an Installer -*Last Updated on March 1, 2021* +*Last Updated on March 4, 2021* Follow the [build guide](BUILD.md) to figure out how to build Vircadia for your platform.