Skip to content

Latest commit

 

History

History
177 lines (133 loc) · 5.34 KB

README.rst

File metadata and controls

177 lines (133 loc) · 5.34 KB
Raw

Original work by wildcardcorp.com

For access to Castle Cloud (our hosted CastleCMS service) or to request customizations or demos, please contact us at https://castlecms.io or https://wildcardcorp.com

[email protected]

+1 (715) 869-3440

Welcome to the main CastleCMS package!

Feature List

In addition to Plone standard features, CastleCMS includes:

  • Login/lockout support
  • Content archival to Amazon S3 storage
  • Large files automatically moved to S3 storage
  • Redis cache support
  • Advanced content layout editor
  • Improved management toolbar
  • Intuitive content creation and organization
  • Opensearch integration
  • Search results tuned by social media impact
  • Search results pinning
  • Celery task queue integration (asynchronous actions)
    • PDF generation
    • Video conversion
    • Amazon S3 interaction
    • copying and pasting of large batches of items
    • deletion and renaming of large batches of items
  • Advanced content tiles:
    • maps
    • videos
    • audio
    • sliders
    • galleries
    • table of contents
  • Audio and video content
  • Automatic conversion of videos to web compatible format
  • Search weighting based on popularity using Google Analytics API
  • Content alias management
  • Disqus commenting integration
  • reCAPTCHA integration
  • fullcalendar integration
  • Google Business metadata
  • Emergency notification system with optional SMS support
  • Preview content on a variety of device sizes
  • Map content
  • KML feeds
  • Social media integration with Twitter, Facebook, Pinterest
  • Etherpad collaborative spaces support
  • Stripping metadata from files
  • Ability to view the site as another user
  • Audit log, user activity reports
  • Session management, inspection and termination
  • Analytics dashboard
  • De-duplication of uploaded images and files
  • Trash can / recycle bin
  • Two factor authentication

Installation

There are various methods of setting up CastleCMS for production, contact Wildcard Corp for optional support. Our preffered local setup is laid out here.

Dependencies

  • Redis
  • avconv (needs to be updated for ffmpeg again)
  • Opensearch 1.1+

Development setup on macOS

  1. brew install redis opensearch libav python
  2. git clone [email protected]:castlecms/castle.cms.git
  3. cd castle.cms
  4. virtualenv -p python2.7 .
  5. bin/pip install --upgrade pip
  6. bin/pip install -r requirements.txt
  7. bin/buildout
  8. Run (in separate terminal windows) opensearch, redis-server, bin/instance fg
  9. Browse to http://localhost:8080/

Once you have created a site in the development instance:

  1. Run compile-resources script to allow Makefile targets to work, bin/plone-compile-resources --site-id <Castle, or whatever you named your site>
  2. Run init-dev script to populate templates, bin/instance run castle/cms/_scripts/init-dev.py
  3. See the /docs/ folder for further development information

Optional Dependencies

  • Install argon2_cffi to use more secure password hashing.
  • https://github.com/castlecms/castlehps for faster search integration
  • Amazon S3 credentials to store large files on S3
  • Google API keys for Google analytics and Recaptcha integrations
  • Plivo API for SMS

Running tests

Default plone testing:

./bin/test -s castle.cms

To run only robot tests:

./bin/test -s castle.cms -t robot

Without robot:

./bin/test -s castle.cms -t \!robot

If you have errors complaining about warning, make sure the version of selenium you're using works with the version of Firefox you have installed (see above)

Running local dependencies with docker

$ docker-compose up

or, just the essentials: $ docker run -p 6379:6379 redis $ docker run -p 9200:9200 opensearchproject/opensearch:latest

Forks/Custom releases

Castle maintains forks and custom releases of packages occasionally. Here is the status and reasoning for our forks: