├── .gitignore ├── LICENSE ├── README.md ├── Vagrantfile └── vagrant_provision.sh /.gitignore: -------------------------------------------------------------------------------- 1 | /.vagrant 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Elixir provisioning for Vagrant 2 | 3 | ## What is it for? 4 | 5 | Developers can use a Virtual Machine (VM) for development in order to quickly get up and running with a system that has Elixir installed. Everyone will have the same setup regardless of the host machine. 6 | 7 | The VM will have: 8 | * Linux (Ubuntu) 9 | * Erlang 10 | * Elixir 11 | * PostgreSQL 12 | * nodejs 6 and other dependencies for the Phoenix framework 13 | 14 | The provisioning script can easiliy be modified for other versions of the software. 15 | 16 | If a Phoenix project is detected during the first `vagrant up`, the database will also be set up and seeded. 17 | 18 | ## Prerequisites 19 | 20 | * Install Vagrant ( https://www.vagrantup.com/ ) 21 | * Install VirtualBox ( https://www.virtualbox.org/ ) or alternatively VMWare. 22 | 23 | ## How to use it 24 | 25 | 1. Add the two files `Vagrantfile` and `vagrant_provision.sh` to any directory. With an Elixir project in it or not. 26 | 2. Run `vagrant up` This will take a while the first time as it will install Erlang, Elixir, PostgreSQL and more. 27 | 3. SSH into the vagrant box with `vagrant ssh`. 28 | 29 | The `/vagrant` directory will be linked to the project directory on the host machine. 30 | 31 | ## Version control 32 | 33 | `Vagrantfile` and `vagrant_provision.sh` should be added to version control. 34 | On the other hand it is recommended to ignore the `.vagrant` directory. If you are using git you could add this line to `.gitignore`: 35 | `.vagrant/*` 36 | 37 | ## Phoenix / inotify auto-reload issues 38 | 39 | Warning: There are issues with Phoenix auto reloading and Vagrant. This appears to be because 40 | of inotify being incompatible with the `/vagrant` directory being connected to the host file system. 41 | 42 | Vagrant can still be used for instance for doing releases of a Phoenix project. 43 | 44 | ## Warning: Hex dependencies 45 | 46 | If you do `mix deps.get` on the vagrant machine it will get dependencies appropriate for that. 47 | Some dependencies are only compatible for that machine. This means that if you run `mix deps.get` 48 | on the vagrant machine you can only use those kinds of dependencies on the vagrant machine and not 49 | on the host. And vice versa. 50 | -------------------------------------------------------------------------------- /Vagrantfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | VAGRANTFILE_API_VERSION = "2" 4 | 5 | VM_NAME = "my_elixir_vm" 6 | MEMORY_SIZE_MB = 1024 7 | NUMBER_OF_CPUS = 2 8 | 9 | Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| 10 | config.vm.box = "ubuntu/xenial64" 11 | 12 | config.vm.define "elixir_box" do |elixir_box| 13 | elixir_box.vm.provider "virtualbox" do |v| 14 | v.name = VM_NAME 15 | v.customize ["modifyvm", :id, "--memory", MEMORY_SIZE_MB] 16 | v.customize ["modifyvm", :id, "--cpus", NUMBER_OF_CPUS] 17 | end 18 | elixir_box.vm.network :private_network, ip: "192.168.55.55" 19 | elixir_box.vm.network :forwarded_port, guest: 5432, host: 45432 20 | elixir_box.vm.provision :shell, :path => "vagrant_provision.sh" 21 | end 22 | end 23 | -------------------------------------------------------------------------------- /vagrant_provision.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | ERLANG_VERSION=19.2 4 | ELIXIR_VERSION=1.4.0 5 | NODE_VERSION=6 6 | 7 | # Note: password is for postgres user "postgres" 8 | POSTGRES_DB_PASS=postgres 9 | POSTGRES_VERSION=9.5 10 | 11 | # Set language and locale 12 | apt-get install -y language-pack-en 13 | locale-gen --purge en_US.UTF-8 14 | echo "LC_ALL='en_US.UTF-8'" >> /etc/environment 15 | dpkg-reconfigure locales 16 | 17 | # Install basic packages 18 | # inotify is installed because it's a Phoenix dependency 19 | apt-get -qq update 20 | apt-get install -y \ 21 | wget \ 22 | git \ 23 | unzip \ 24 | build-essential \ 25 | ntp \ 26 | inotify-tools 27 | 28 | # Install Erlang 29 | echo "deb http://packages.erlang-solutions.com/ubuntu xenial contrib" >> /etc/apt/sources.list && \ 30 | apt-key adv --fetch-keys http://packages.erlang-solutions.com/ubuntu/erlang_solutions.asc && \ 31 | apt-get -qq update && \ 32 | apt-get install -y -f \ 33 | esl-erlang="1:${ERLANG_VERSION}" 34 | 35 | # Install Elixir 36 | cd / && mkdir -p elixir && cd elixir && \ 37 | wget -q https://github.com/elixir-lang/elixir/releases/download/v$ELIXIR_VERSION/Precompiled.zip && \ 38 | unzip Precompiled.zip && \ 39 | rm -f Precompiled.zip && \ 40 | ln -s /elixir/bin/elixirc /usr/local/bin/elixirc && \ 41 | ln -s /elixir/bin/elixir /usr/local/bin/elixir && \ 42 | ln -s /elixir/bin/mix /usr/local/bin/mix && \ 43 | ln -s /elixir/bin/iex /usr/local/bin/iex 44 | 45 | # Install local Elixir hex and rebar for the ubuntu user 46 | su - ubuntu -c '/usr/local/bin/mix local.hex --force && /usr/local/bin/mix local.rebar --force' 47 | 48 | # Postgres 49 | sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" >> /etc/apt/sources.list.d/pgdg.list' 50 | wget -q https://www.postgresql.org/media/keys/ACCC4CF8.asc -O - | apt-key add - 51 | apt-get update 52 | apt-get -y install postgresql-$POSTGRES_VERSION postgresql-contrib-$POSTGRES_VERSION 53 | 54 | PG_CONF="/etc/postgresql/$POSTGRES_VERSION/main/postgresql.conf" 55 | echo "client_encoding = utf8" >> "$PG_CONF" # Set client encoding to UTF8 56 | service postgresql restart 57 | 58 | cat << EOF | su - postgres -c psql 59 | ALTER USER postgres WITH ENCRYPTED PASSWORD '$POSTGRES_DB_PASS'; 60 | EOF 61 | 62 | # Install nodejs and npm 63 | curl -sL https://deb.nodesource.com/setup_$NODE_VERSION.x | sudo -E bash - 64 | apt-get install -y \ 65 | nodejs 66 | 67 | # Install imagemagick 68 | apt-get install -y imagemagick 69 | 70 | # If seeds.exs exists we assume it is a Phoenix project 71 | if [ -f /vagrant/priv/repo/seeds.exs ] 72 | then 73 | # Set up and migrate database 74 | su - ubuntu -c 'cd /vagrant && mix deps.get && mix ecto.create && mix ecto.migrate' 75 | # Run Phoenix seed data script 76 | su - ubuntu -c 'cd /vagrant && mix run priv/repo/seeds.exs' 77 | fi 78 | --------------------------------------------------------------------------------