znanl/islandzero

IslandZero

Site https://www.island0.com

Forum https://www.island0.com/topics/1

Github (Main Repo) https://github.com/IslandZero/IslandZero

Gitcafe(Mirror Repo) https://gitcafe.com/yanke_guo/IslandZero

Requirements

• Ruby (Modern)
• Redis
• MySQL

Configuration

IslandZero use Figaro for configuration.

• Copy config/application.yml.sample to config/application.yml, then edit it.

It is suggested to move all parameters to config/application.yml, Capistrano will handle it well.

Run

• Thin (see config/thin/production.yml)
• Sidekiq (see config/sidekiq.yml)

Deploy via Docker, build by yourself

• Install docker.
• Install fig.
• Create /data/mysql, /data/redis, /data/uploads for persistence.
• Pull this repo to a folder
• Copy fig.sample.self_build.yml to fig.yml then edit it with MySQL user and password.
• Copy config/application.sample.yml to config/application.yml and edit it.
• fig up -d to start, wait a bit more time after command finished.
• For newly installed only:
  • fig run web rake db:drop drop the auto-created database due to known issue, see below.
  • fig run web rake db:create create an new database.
• fig run web rake db:migrate to migrate db to latest schema.
• Setup nginx to proxy 3000 to 80.

Deploy via Docker, from image

• Install docker.
• Install fig.
• Create /data/mysql, /data/redis, /data/uploads for persistence.
• Download fig.sample.from_repo.yml to fig.yml then edit it with MySQL user, password and other parameters from config/application.sample.yml.
• fig up -d to start, wait a bit more time after command finished.
• For newly installed only:
  • fig run web rake db:drop drop the auto-created database due to known issue, see below.
  • fig run web rake db:create create an new database.
• fig run web rake db:migrate to migrate db to latest schema.
• Setup nginx to proxy 3000 to 80.

Deploy Via Capistrano (Legacy, May have bugs, Not suggested)

• Install ruby, mysql, redis in your remote server and start them.
• Copy config/application.yml.sample to config/application.yml, then edit it, don't forget to add a server.
• Run bundle exec cap deploy:setup, prepare initial environment.
• Run bundle exec cap figaro:setup, deploy local application.yml to remote.
• Run bundle exec cap deploy, deploy a new release.
• Run bundle exec cap deploy:restart, restart thin.

Known issues

MySQL charset problem with Docker

Official MySQL package will automatically create database without utf8 support.

To solve this issue, drop the auto-created database and recreate with rake.

Development

Feel free to fork or open issues.

LICENSE

The MIT License (MIT)

Copyright (c) 2014 YANKE Guo [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Third Party

Bootstrap Markdown