{"id":20186200,"url":"https://github.com/startcloud/vagrant-local-example","last_synced_at":"2025-03-03T06:44:33.732Z","repository":{"id":217703324,"uuid":"744535896","full_name":"STARTcloud/vagrant-local-example","owner":"STARTcloud","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-17T14:02:39.000Z","size":85,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-13T18:16:58.560Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/STARTcloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-17T13:57:29.000Z","updated_at":"2024-01-17T15:38:17.000Z","dependencies_parsed_at":"2024-01-18T00:32:58.103Z","dependency_job_id":"16c3e276-b585-4705-b3e4-47ffa0f20107","html_url":"https://github.com/STARTcloud/vagrant-local-example","commit_stats":null,"previous_names":["startcloud/vagrant-local-example"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/STARTcloud%2Fvagrant-local-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/STARTcloud%2Fvagrant-local-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/STARTcloud%2Fvagrant-local-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/STARTcloud%2Fvagrant-local-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/STARTcloud","download_url":"https://codeload.github.com/STARTcloud/vagrant-local-example/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241622593,"owners_count":19992501,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T03:16:22.875Z","updated_at":"2025-03-03T06:44:33.700Z","avatar_url":"https://github.com/STARTcloud.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/DominoVagrant/demo-v2-task-based/\"\u003e\n    \u003cimg src=\"https://startcloud.com/assets/logo-big.jpg\" alt=\"Logo\" width=\"200\" height=\"100\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eDomino Vagrant Build\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    An README to jumpstart your build of the Domino Development\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/DominoVagrant/demo-v2-task-based/\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/DominoVagrant/demo-v2-task-based/\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/DominoVagrant/demo-v2-task-based/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/DominoVagrant/demo-v2-task-based/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n## Table of Contents\n\n* [About the Project](#dominovagrant)\n  * [Built With](#built-with)\n* [Getting Started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n    * [Mac OS X](https://github.com/DominoVagrant/demo-v2-task-based/blob/master/MacMojaveReadme.md) -- Quick Start\n    * [Windows](https://github.com/DominoVagrant/demo-v2-task-based/blob/master/Win10ReadMe.md) -- Quick Start\n* [Deployment](#deployment)\n  * [Cloning](#cloning-the-repo-locally)\n  * [Overview](#configuring-the-environment)\n  * [Variables](#commonly-changed-parameters)\n  * [Source Files](#source-files)\n* [Initialization](#starting-the-vm) \n  * [Access Methods](#accessing-the-domino-server)\n    * [Web](#web-interface)\n    * [Notes Client](#access-from-notes-client)\n    * [Console](#domino-console)\n* [Common Issues](#common-problems) \n* [Roadmap](#roadmap)\n* [Contributing](#contributing)\n* [License](#license)\n* [Contact](#authors)\n* [Acknowledgements](#acknowledgments)\n\n\n## DominoVagrant\nPrimary goal is to use Vagrant to deploy the latest Domino Server in an Linux VM. Vagrant and Role Specific Variables will be passed along, automating installation via the RestAPI interace and Mooneshine or other tools that support CRUD API calls. This uses a Specialized Packer Build that cuts down deployment time: \n\n* **Template:** [Packer](https://app.vagrantup.com/STARTcloud/boxes/debian11-server)\n* **Build Source:** [Repo](Notyetavailableforpublicconsumption)\n\nEach Release will be a at the time, stable branch. Recommended to use the latest.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes, as well as what will power the build process of the VMs at Prominic.NET.\n\n### Prerequisites\n\nYou will need some software on your PC or Mac:\n\n```\ngit\nVagrant\nVirtualbox\n```\n\n## Installation\n\nTo ease deployment, we have a few handy scripts that will utlize a package manager for each OS to get the pre-requisite software for your host OS. This is NOT required, this is to help you ensure you have all the applications that are neccessary to run this VM.\n\n#### Windows\nPowershell has a package manager named Chocalatey which is very similar to SNAP, YUM, or other Package manager, We will utilize that to quickly install Virtualbox, Vagrant and Git.\n\nPowershell\n```powershell\nSet-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))\nchoco install vagrant\nchoco install virtualbox\nchoco install git.install\n```\n\nFor those that need to run this in a Command Prompt, you can use this:\n\nCMD\n```bat\n@\"%SystemRoot%\\System32\\WindowsPowerShell\\v1.0\\powershell.exe\" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command \"iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))\" \u0026\u0026 SET \"PATH=%PATH%;%ALLUSERSPROFILE%\\chocolatey\\bin\"\nchoco install vagrant\nchoco install virtualbox\nchoco install git.install\n```\n\n#### Mac\nJust like Windows and other Linux repos, there is a similar package manager for Mac OS X, Homebrew, We will utilize that to install the prequsites. You will likley need to allow unauthenticated applications in the Mac OS X Security Settings, there are reports that Mac OS X Mojave will require some additional work to get running correctly. You do NOT have to use these scripts to get the pre-requisites on your Mac, it is recommened, you simply need to make sure you have the 3 applications installed on your Mac.\n\n```shell\n/usr/bin/ruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"\nbrew cask install virtualbox\nbrew cask install vagrant\nbrew cask install vagrant-manager\nbrew install git\n```\n\n#### CentOS 7\nWe will utilize YUM and a few other bash commands to get the Virtualbox, Git,  and Vagrant installed.\n\nYUM\n```shell\nyum -y install gcc dkms make qt libgomp patch kernel-headers kernel-devel binutils glibc-headers glibc-devel font-forge\ncd /etc/yum.repo.d/\nwget http://download.virtualbox.org/virtualbox/rpm/rhel/virtualbox.repo\nyum install -y VirtualBox-5.1\n/sbin/rcvboxdrv setup\nyum -y install https://releases.hashicorp.com/vagrant/1.9.6/vagrant_1.9.6_x86_64.rpm\nsudo yum install git\n```\n\n#### Ubuntu\nWe will utilize APT to get the Virtualbox, Git,  and Vagrant installed.\n\nAPT\n```shell\nsudo apt-get install virtualbox vagrant git-core -y \n```\n\n## Deployment\n### Cloning the repo locally\n\nOpen up a terminal and perform the following git command in order to save the Project to a local folder:\n\n```shell\ngit clone https://github.com/DominoVagrant/demo-v2-task-based\n```\n\n### Configuring the Environment\nOnce you have navigated into the projects directory. You will need to modify the Hosts.yml to your specific Environment.\n\nPlease set the configuration file with the correct, Network and Memory and CPU settings your host machine will allow, as these may vary from system to system, I cannot predict your Machines CPU and Network Requirements. You will need to make sure that you do not over allocate CPU, and RAM. \n\n##### Networking is setup to create one NAT adapter for Vagrant communications and one Bridged Adapter. \nThe bridge adapter needs to be specified or it will prompt upon deployment. \nSetting dhcp4 to true (ipv6 not yet fully supported try at your own risk) will pull a IP from your local network's DHCP server.\n\n##### Secrets\n\nIf you have any sensitive credentials, You will also need to create ```.secrets.yml``` in the root of the project. This is where you can store credentials variables that may contain sensitive data. this will prevent you from uploading them to the repo should you contribute back. Please note that if you remove this from the .gitignore you risk uploading sensitve data. \n\n```\ncd demo-v2-task-based\ntouch .secrets.yml\nnano Hosts.yml\n```\n\n## Commonly Changed Parameters:\n\n* ip: Use any IP on your Internal Network that is NOT in use by any other machine.\n* gateway: This is the IP of your Router\n* dhcp4: true/false\n* hostname: This is the Hostname of the VM,\n* domain: This is the domain to complete the FQDN\n* mac: This is your machines Network unique identifier, if you run more than one instance on a network, randonmize this. [Mac Generator](https://www.miniwebtool.com/mac-address-generator/)\n* netmask: Set this to the subnet you have your network configured to. This is normally: 255.255.255.0\n* name: The Vagrant unique identifier\n* cpu: The number of cores you are allocating to this machine. Please beware and do not over allocate. Overallocation may cause instability\n* memory: The amount of Memory you are allocating to the machine.  Please beware and do not over allocate. Overallocation may cause instability\n\n\n\n### Modifying Roles\nThe default provisioning engine is ansible-local. This allows us to template our variables into files before deploying and executing the installers.\nThis allows us to set dynamic usernames, paths, passwords, etc. \n\n#### Domino One-Touch References\nIn order to make changes to the one touch installer. Modify the template file setup.json.j2 in the /templates folder of the role \"domino-config\".\n\nYou can find more information on the fields and how they correspond to Field Values in Doimino designer here:\n\n[Domino-OneTouch](https://help.hcltechsw.com/domino/12.0.0/admin/inst_usingthedominoserversetupprogram_c.html)\n\n## Source Files\n\nIf you have Domino and the installations files in a remote repository.\nYou can define them in the Hosts.yml under their respective variables.\n\nIf you do not have a repository to pull your installation files from.\nYou can place the archived installers in the ./installers/{{APPLICATION}}/archived directory.\nThese will be expanded into their respective folders under /vagrant/installers/{{APPLICATION}}/archived.\n\nYou will need to supply the Domino installer and optional fix pack files\nyourself (eg, Domino_12.0_Linux_English.tar, Domino_1101FP2_Linux.tar).\n\n## Cross Certifying\n\nIf you want to access the server from a Notes ID, create a safe ID using the instructions [here](#access-from-notes-client)\n\n**Place your file into the ./safe-id-to-cross-certify folder.**\n\n## Starting the VM\nThe installation process is estimated to take about 15 - 30 Minutes.\n\n```\nvagrant up\n```\n\nAt this point, you can execute 'vagrant up' in the git checkout directory\nto spin up a vm instance, or use the utility scripts\n./scripts/vagrant_up.sh, ./scripts/vagrant_up.ps1 to create a log file with the initialization\noutput in addition to showing on the screen.\n\nOnce the system has been provisioned, you can use 'vagrant ssh' to access\nit, or again the utility scripts vagrant_ssh.sh/vagrant_ssh.ps1 to create\na log file of the ssh session.\n\nView the contents of the CommandHelp.text for more details.\nThis file will also be displayed followed each vagrant up operation for\nyour continued reference.\n\n## Accessing the Domino Server\n\nThe Domino server will be started automatically when `vagrant up` completes.\n\n### Domino Console\n\nTo access the console, run:\n\n```vagrant ssh -c \"screen -r\"```\nor\n```vagrant ssh -c \"sudo domino console\"```\n\n### Web Interface\n\nThe web interface of the server is here:  https://yourstaticordhcpip:443/downloads/welcome.html\n\n### Access from Notes Client\n\nIf you want to access the server from a Notes Client, you will need to cross-certify your ID.  To do this, first create a safe ID:\n1. Open User Security:\n\t- MacOS:  HCL Notes \u003e Security \u003e User Security \n\t- Windows:  File \u003e Security \u003e User Security\n2. Select the Your Identity \u003e Your Certificates tab\n3. Run Other Actions \u003e Export NotesID Safe ID.  Do not set a password\n\nCopy this ID to `./safe-id-to-cross-certify` and update `safe_notes_id`, and run `vagrant up`.\n\nThen you will need to create a connection document in your local Notes client.\n1. File \u003e Open \u003e HCL Notes Application\n2. Open names.nsf on your local machine\n3. Click `Advanced` in the bottom of the left sidebar\n4. Open the Connections view\n5. Click New \u003e Server Connection\n\t1. In the Basic tab, set `Server name` as \"demo/Demo\" and check the `TCP/IP` checkbox\n\t2. In the Advanced tab, set the `Destination server address` to \"127.0.0.1:1352\"\n\t3. Click `Save \u0026 Close`\n\t\nThen you can open a database on the server like this:\n1. File \u003e Open \u003e HCL Notes Application\n2. Enter \"demo/DEMO\" as the server name\n3. Select a database (like names.nsf) and click Open\n\n### Domino Default Credentials\n\n* username: Demo Admin\n* password: password\n\n## Common Problems\n\n### Error for Headless VirtualBox\n\nIf you get an error indicating that VirtualBox could not start in headless mode, open Vagrantfile and uncomment this line\n\n```\n     #vb.gui = true\n```\n\n## Roadmap\n\nSee the [open issues](https://github.com/DominoVagrant/demo-v2-task-based/issues) for a list of proposed features (and known issues).\n\n## Built With\n* [Vagrant](https://www.vagrantup.com/) - Portable Development Environment Suite.\n* [VirtualBox](https://www.virtualbox.org/wiki/Downloads) - Hypervisor.\n* [Ansible](https://www.ansible.com/) - Virtual Manchine Automation Management.\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](https://www.prominic.net) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Authors\n* **Joel Anderson** - *Initial work* - [JoelProminic](https://github.com/JoelProminic)\n* **Justin Hill** - *Initial work* - [JustinProminic](https://github.com/JustinProminic)\n* **Mark Gilbert** - *Refactor* - [MarkProminic](https://github.com/MarkProminic)\n\nSee also the list of [contributors](https://github.com/DominoVagrant/demo-v2-task-based/graphs/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the SSLP v3 License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n* Hat tip to anyone whose code was used\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstartcloud%2Fvagrant-local-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstartcloud%2Fvagrant-local-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstartcloud%2Fvagrant-local-example/lists"}