Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 3.14 KB

README.md

File metadata and controls

73 lines (54 loc) · 3.14 KB
Raw

Redress

LIVE DEMO Build Status

Open Source Self-Service Driver/Documentation CMS

For visitors, Redress is a basic, go-to self-service portal to download documentation and drivers for products.

For administrators, Redress is an easy to use content management system to list your documentation, drivers, and other files for your products.

Redress was born out of necessity to replace an aging single HTML file listing FTP links to download quick configuration guides, drivers, and etc. Redress is slightly opinionated by storing uploads on Amazon S3 (can be configured to any other FOG provider or local storage). This has some obvious benefits, especially when comparing to local or FTP storage. By default the app expects a Mandrill account for notification emails. However this can be configured to just use a simple SMTP server to your preference. With baked-in administration, managing product listings is simple and intuitive.

The Guts

  • Ruby 2.2.3
  • Rails 4.2.4
  • PostgreSQL
  • Amazon S3 (expects by default, can be changed in configuration)
  • Mandrill (expects by default, can be changed in configuration)

Getting Started

  • Make sure you have Ruby 2.2.3
  • Clone git repo, or download .zip
  • run bin/bundle install
  • confirm database.yml settings
  • bin/rake db:setup
  • make note of default admin user/password created in console (or look in seeds.rb), for production this is set in .env
  • run bin/rails server
  • login and populate. (right now it's configured to upload to Amazon S3, so either change settings as needed or change it to local file storage)

Issues

If you come across some bugs or errors, please report an issue with detailed description.

Contributing

Pull requests, feature suggetions, and bug reports are all welcome.

Special Thanks

A special thanks is due to @rhizome for serious contributions and help during the initial development of the project on the old repo.

License

MIT License

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.