{"id":15958646,"url":"https://github.com/cirosantilli/softcover_vagrant","last_synced_at":"2026-05-04T21:30:20.556Z","repository":{"id":14821418,"uuid":"17544051","full_name":"cirosantilli/softcover_vagrant","owner":"cirosantilli","description":"Ubuntu 12.04 64 bit Vagrant virtual machine for Softcover usage and development.","archived":false,"fork":false,"pushed_at":"2014-08-17T07:02:29.000Z","size":336,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-02T05:13:39.096Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cirosantilli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-03-08T14:57:32.000Z","updated_at":"2019-12-24T10:38:18.000Z","dependencies_parsed_at":"2022-09-23T23:20:20.972Z","dependency_job_id":null,"html_url":"https://github.com/cirosantilli/softcover_vagrant","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirosantilli%2Fsoftcover_vagrant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirosantilli%2Fsoftcover_vagrant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirosantilli%2Fsoftcover_vagrant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirosantilli%2Fsoftcover_vagrant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cirosantilli","download_url":"https://codeload.github.com/cirosantilli/softcover_vagrant/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240088643,"owners_count":19746118,"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-07T14:20:21.846Z","updated_at":"2026-05-04T21:30:20.512Z","avatar_url":"https://github.com/cirosantilli.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Softcover Vagrant\n\nUbuntu 12.04 64 bit Vagrant virtual machine for [Softcover](https://github.com/softcover/softcover) usage and development.\n\n**STATUS**:\n\nThe `softcover new` template and `softcover_book` build correctly on all formats.\n\nExactly 3 unit tests fail, all of which are Softcover bugs:\n\n- \u003chttps://github.com/softcover/softcover/issues/102\u003e\n- \u003chttps://github.com/softcover/softcover/pull/103\u003e\n\n## I already know Vagrant\n\n    git clone https://github.com/cirosantilli/softcover_vagrant\n    cd softcover_vagrant\n    vagrant up\n    vagrant ssh\n\nIn the SSH:\n\n    cd /vagrant/projects\n    softcover new example_book\n    cd example_book\n    softcover build\n    softcover serve\n\nYour book is ready under the `projects/example_book` subdirectory in the host, and can be previewed at `localhost:4000`.\n\nNext project?\n\n    cd /vagrant/projects\n    softcover new example_book2\n\n## I am new to Vagrant\n\nA virtual machine will install another OS inside of your OS, which you can access via SSH. The main OS is called the *host*, while the one inside it is called the *guest*.\n\nThe advantage of using a virtual machine is that it makes it easier to install Softcover for usage and development as all you have to do is to:\n\n- install the virtual machine\n- and Softcover will automatically be installed in the guest by a startup script\n\nWe feel that installing the virtual machine is easier than installing Softcover.\n\n### Install Vagrant\n\nInstall [Vagrant](http://www.vagrantup.com/), which will also require you so install a VM provider. We officially support [Oracle VirtualBox](https://www.virtualbox.org/), which is free and cross platform.\n\nVagrant is cross platform and easy to install. For example on Ubuntu 12.04 use:\n\n    # VirtualBox\n    wget -q http://download.virtualbox.org/virtualbox/debian/oracle_vbox.asc -O- | sudo apt-key add -\n    sudo sh -c 'echo \"deb http://download.virtualbox.org/virtualbox/debian raring contrib\" \u003e\u003e /etc/apt/sources.list.d/virtualbox.list'\n    sudo apt-get update\n    sudo apt-get install -y virtualbox-4.2\n\n    # Vagrant\n    firefox http://www.vagrantup.com/downloads.html\n    # Click on the download for you system.\n    cd download_dir\n    sudo dpkg -i vagrant_*.deb\n\nAvoid installing Vagrant from the Ubuntu repositories as the versions there are very outdated.\n\nIt is recommended that you enable hardware virtualization from your BIOS screen, the first screen that appears then you turn the computer on.\n\n### Usage\n\nGo to the root of this repository and do:\n\n    vagrant up\n\nThis starts up the Ubuntu 12.04 guest virtual machine.\n\nThe first time you do `vagrant up` the command will take a long time to execute (~30 minutes) since it will download and install the virtual machine.\n\nOnce the machine is up, ssh into the guest with:\n\n    vagrant ssh\n\nTo create a new book simply to the following from inside the guest:\n\n    cd /vagrant/projects\n    softcover new example_book\n\nOn the host, you will see that the `projects/` directory of this repository is exactly equal to the `/vagrant/projects` directory in the guest machine.\n\nYou can edit your book from your host machine on you favorite editor, and only use the `ssh` when you want to do Softcover commands.\n\nPort forwarding is already configured, so if you do:\n\n    softcover serve\n\non the guest, then you can visit: `localhost:4000` on the host and your book will be there.\n\nThis means that port 4000 must be free or the virtual machine won't boot. If port 4000 is already in use, you can edit the line:\n\n    config.vm.network\n\nin this `Vagrantfile` to set it to another value.\n\n## Develop Softcover\n\nYou can also use this repository to develop Softcover itself.\n\nFrom the host, `cd` to the root of this repository and clone Softcover:\n\n    git clone https://github.com/softcover/softcover\n\nIt is already gitignored.\n\nFor interactive tests, create the project under `projects` and add following Gemfile to the project's directory:\n\n    cat \u003c\u003cEOF \u003e Gemfile\n    source 'https://rubygems.org'\n    ruby '2.1.1'\n    gem 'softcover', :path =\u003e '../../softcover'\n    EOF\n\nand don't forget to use `bundle exec` all the time from the guest:\n\n    bundle exec softcover build\n\nRun the unit tests from the guest via:\n\n    cd /vagrant/softcover\n    bundle install\n    bundle exec rake spec\n\n## Develop this VM\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for more info on how to contribute to this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirosantilli%2Fsoftcover_vagrant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcirosantilli%2Fsoftcover_vagrant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirosantilli%2Fsoftcover_vagrant/lists"}