{"id":15878618,"url":"https://github.com/tdd/my-boxen","last_synced_at":"2025-10-29T09:47:17.221Z","repository":{"id":10984873,"uuid":"13304211","full_name":"tdd/my-boxen","owner":"tdd","description":"My Boxen setup","archived":false,"fork":false,"pushed_at":"2013-10-04T09:22:27.000Z","size":46080,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-07T15:31:43.775Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tdd.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}},"created_at":"2013-10-03T17:06:03.000Z","updated_at":"2013-10-04T09:22:31.000Z","dependencies_parsed_at":"2022-09-02T01:20:53.366Z","dependency_job_id":null,"html_url":"https://github.com/tdd/my-boxen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdd%2Fmy-boxen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdd%2Fmy-boxen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdd%2Fmy-boxen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdd%2Fmy-boxen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tdd","download_url":"https://codeload.github.com/tdd/my-boxen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246730293,"owners_count":20824396,"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-10-06T02:40:46.854Z","updated_at":"2025-10-29T09:47:12.187Z","avatar_url":"https://github.com/tdd.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Our Boxen\n\nThis is a template Boxen project designed for your organization to fork and\nmodify appropriately.\nThe Boxen rubygem and the Boxen puppet modules are only a framework for getting\nthings done.\nThis repository template is just a basic example of _how_ to do things with them.\n\n## Getting Started\n\nTo give you a brief overview, we're going to:\n\n* Install dependencies (basically Xcode)\n* Bootstrap a boxen for your self/team/org/company\n* Then convert your local copy of that boxen to the post-bootstrapped version\n\nThere are a few potential conflicts to keep in mind.\nBoxen does its best not to get in the way of a dirty system,\nbut you should check into the following before attempting to install your\nboxen on any machine (we do some checks before every Boxen run to try\nand detect most of these and tell you anyway):\n\n* Boxen __requires__ at least the Xcode Command Line Tools installed.\n* Boxen __will not__ work with an existing rvm install.\n* Boxen __may not__ play nice with a GitHub username that includes dash(-)\n* Boxen __may not__ play nice with an existing rbenv install.\n* Boxen __may not__ play nice with an existing chruby install.\n* Boxen __may not__ play nice with an existing homebrew install.\n* Boxen __may not__ play nice with an existing nvm install.\n* Boxen __recommends__ installing the full Xcode.\n\n### Dependencies\n\n**Install the Xcode Command Lines Tools and/or full Xcode.**\nThis will grant you the most predictable behavior in building apps like\nMacVim.\n\nHow do you do it?\n\n1. Install Xcode from the Mac App Store.\n1. Open Xcode.\n1. Open the Preferences window (`Cmd-,`).\n1. Go to the Downloads tab.\n1. Install the Command Line Tools.\n\n### Bootstrapping\n\nCreate a **new** git repository somewhere.\nIt can be private or public -- it really doesn't matter.\nIf you're making a repository on GitHub, you _may not_ want to fork this repo\nto get started.\nThe reason for that is that you can't really make private forks of public\nrepositories easily.\n\nOnce you've done that, you can run the following to bootstrap\nyour boxen:\n\n```\nsudo mkdir -p /opt/boxen\nsudo chown ${USER}:staff /opt/boxen\ngit clone https://github.com/boxen/our-boxen /opt/boxen/repo\ncd /opt/boxen/repo\ngit remote rm origin\ngit remote add origin \u003cthe location of my new git repository\u003e\ngit push -u origin master\n```\n\n### Distributing\n\nThat's enough to get your boxen into a usable state on other machines,\nusually.\nFrom there, we recommend setting up\n[boxen-web](https://github.com/boxen/boxen-web)\nas an easy way to automate letting other folks install your boxen.\n\nIf you _don't_ want to use boxen-web, folks can get using your boxen like so:\n\n```\nsudo mkdir -p /opt/boxen\nsudo chown ${USER}:staff /opt/boxen\ngit clone \u003clocation of my new git repository\u003e /opt/boxen/repo\ncd /opt/boxen/repo\nscript/boxen\n```\n\nKeep in mind this requires you to encrypt your hard drive by default.\nIf you do not want to do encrypt your hard drive, you can use the `--no-fde`.\n\n```\nscript/boxen --no-fde\n```\n\nIt should run successfully, and should tell you to source a shell script\nin your environment.\nFor users without a bash or zsh config or a `~/.profile` file,\nBoxen will create a shim for you that will work correctly.\nIf you do have a `~/.bashrc` or `~/.zshrc`, your shell will not use\n`~/.profile` so you'll need to add a line like so at _the end of your config_:\n\n``` sh\n[ -f /opt/boxen/env.sh ] \u0026\u0026 source /opt/boxen/env.sh\n```\n\nOnce your shell is ready, open a new tab/window in your Terminal\nand you should be able to successfully run `boxen --env`.\nIf that runs cleanly, you're in good shape.\n\n## What You Get\n\nThis template project provides the following by default:\n\n* Homebrew\n* Git\n* Hub\n* dnsmasq w/ .dev resolver for localhost\n* rbenv\n* Full Disk Encryption requirement\n* Node.js 0.4\n* Node.js 0.6\n* Node.js 0.8\n* Ruby 1.8.7\n* Ruby 1.9.2\n* Ruby 1.9.3\n* ack\n* Findutils\n* GNU tar\n\n## Customizing\n\nYou can always check out the number of existing modules we already\nprovide as optional installs under the\n[boxen organization](https://github.com/boxen). These modules are all\ntested to be compatible with Boxen. Use the `Puppetfile` to pull them\nin dependencies automatically whenever `boxen` is run.\n\n### Including boxen modules from github (boxen/puppet-\u003cname\u003e)\n\nYou must add the github information for your added Puppet module into your Puppetfile at the root of your\nboxen repo (ex. /path/to/your-boxen/Puppetfile):\n\n    # Core modules for a basic development environment. You can replace\n    # some/most of these if you want, but it's not recommended.\n\n    github \"repository\", \"2.0.2\"\n    github \"dnsmasq\",    \"1.0.0\"\n    github \"gcc\",        \"1.0.0\"\n    github \"git\",        \"1.2.2\"\n    github \"homebrew\",   \"1.1.2\"\n    github \"hub\",        \"1.0.0\"\n    github \"inifile\",    \"0.9.0\", :repo =\u003e \"cprice404/puppetlabs-inifile\"\n    github \"nginx\",      \"1.4.0\"\n    github \"nodejs\",     \"2.2.0\"\n    github \"ruby\",       \"4.1.0\"\n    github \"stdlib\",     \"4.0.2\", :repo =\u003e \"puppetlabs/puppetlabs-stdlib\"\n    github \"sudo\",       \"1.0.0\"\n\n    # Optional/custom modules. There are tons available at\n    # https://github.com/boxen.\n\n    github \"java\",     \"1.1.0\"\n\nIn the above snippet of a customized Puppetfile, the bottom line\nincludes the Java module from Github using the tag \"1.1.0\" from the github repository\n\"boxen/puppet-java\".  The function \"github\" is defined at the top of the Puppetfile\nand takes the name of the module, the version, and optional repo location:\n\n    def github(name, version, options = nil)\n      options ||= {}\n      options[:repo] ||= \"boxen/puppet-#{name}\"\n      mod name, version, :github_tarball =\u003e options[:repo]\n    end\n\nNow Puppet knows where to download the module from when you include it in your site.pp or mypersonal.pp file:\n\n    # include the java module referenced in my Puppetfile with the line\n    # github \"java\",     \"1.1.0\"\n    include java\n\n### Node definitions\n\nPuppet has the concept of a\n['node'](http://docs.puppetlabs.com/references/glossary.html#agent),\nwhich is essentially the machine on which Puppet is running. Puppet looks for\n[node definitions](http://docs.puppetlabs.com/learning/agent_master_basic.html#node-definitions)\nin the `manifests/site.pp` file in the Boxen repo. You'll see a default node\ndeclaration that looks like the following:\n\n``` puppet\nnode default {\n  # core modules, needed for most things\n  include dnsmasq\n\n  # more...\n}\n```\n\n### How Boxen interacts with Puppet\n\nBoxen runs everything declared in `manifests/site.pp` by default.\nBut just like any other source code, throwing all your work into one massive\nfile is going to be difficult to work with. Instead, we recommend you\nuse modules in the `Puppetfile` when you can and make new modules\nin the `modules/` directory when you can't. Then add `include $modulename`\nfor each new module in `manifests/site.pp` to include them.\nOne pattern that's very common is to create a module for your organization\n(e.g., `modules/github`) and put an environment class in that module\nto include all of the modules your organization wants to install for\neveryone by default. An example of this might look like so:\n\n``` puppet\n# modules/github/manifests/environment.pp\n\n class github::environment {\n   include github::apps::mac\n\n   include ruby::1-8-7\n\n   include projects::super-top-secret-project\n }\n ```\n\n If you'd like to read more about how Puppet works, we recommend\n checking out [the official documentation](http://docs.puppetlabs.com/)\n for:\n\n * [Modules](http://docs.puppetlabs.com/learning/modules1.html#modules)\n * [Classes](http://docs.puppetlabs.com/learning/modules1.html#classes)\n * [Defined Types](http://docs.puppetlabs.com/learning/definedtypes.html)\n * [Facts](http://docs.puppetlabs.com/guides/custom_facts.html)\n\n### Creating a personal module\n\nSee [the documentation in the\n`modules/people`](modules/people/README.md)\ndirectory for creating per-user modules that don't need to be applied\nglobally to everyone.\n\n### Creating a project module\n\nSee [the documentation in the\n`modules/projects`](modules/projects/README.md)\ndirectory for creating organization projects (i.e., repositories that people\nwill be working in).\n\n## Binary packages\n\nWe support binary packaging for everything in Homebrew, rbenv, and nvm.\nSee `config/boxen.rb` for the environment variables to define.\n\n## Sharing Boxen Modules\n\nIf you've got a Boxen module you'd like to be grouped under the Boxen org,\n(so it can easily be found by others), please file an issue on this\nrepository with a link to your module.\nWe'll review the code briefly, and if things look pretty all right,\nwe'll fork it under the Boxen org and give you read+write access to our\nfork.\nYou'll still be the maintainer, you'll still own the issues and PRs.\nIt'll just be listed under the boxen org so folks can find it more easily.\n\n## Integrating with Github Enterprise\n\nIf you're using a Github Enterprise instance rather than github.com,\nyou will need to set the `BOXEN_GITHUB_ENTERPRISE_URL` and\n`BOXEN_REPO_URL_TEMPLATE` variables in your\n[Boxen config](config/boxen.rb).\n\n## Halp!\n\nSee [FAQ](https://github.com/boxen/our-boxen/blob/master/docs/faq.md).\n\nUse Issues or #boxen on irc.freenode.net.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdd%2Fmy-boxen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftdd%2Fmy-boxen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdd%2Fmy-boxen/lists"}