Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 3.64 KB

README.md

File metadata and controls

63 lines (41 loc) · 3.64 KB
Raw

Minds Engine

Build Status

Back-end system for Minds. Please run inside of the Minds repo.

Documentation

Documentation for Minds can be found at developers.minds.com

Tasks

Running CLI jobs. They must be run inside a container.

  • run ```docker exec -it minds_php-fpm_1 php '/var/www/Minds/engine/cli.php' controller_name task``

Help files and parameters are available for some tasks.

Default admin user

Minds ships with a local user ready to roll.

  • username: minds
  • password: Pa$$w0rd

To enable admin functionality, set 'development_mode' to true in your settings.php post installation.

Syncing the newsfeed

  • Make sure you have at least 1 upvote and a hashtag.
  • Assuming your container is named 'minds_php-fpm_1'
  • run docker exec -it minds_php-fpm_1 php '/var/www/Minds/engine/cli.php' suggested sync_newsfeedinside the php-fpm container

Environment variables locally

Override environment variables locally by adding them to the ./.env file in the root of engine. The file is ignored and won't pick up your changes. These values override the settings in settings.php

Prefix the environment variables with MINDS_ENV_. All others are ignored Suffix the environment variables with the key in Config.php Nest arrays with {prefix}{key}subkey{...}_{Config Key}

You can then manage these ENVs out on the review sites with the Deployment Guide

Running php tests

  • Have a fully setup development environment so all the composer dependencies are installed.
  • To run all tests: bin/phpsec run
  • To run a specific spec, include a specific spec file bin/phpspec run Spec/Core/Feeds/Suggested/RepositorySpec.php
  • To run a specific test in a spec, include a specific spec file:line number of the test function: bin/phpspec run Spec/Core/Feeds/Suggested/RepositorySpec.php:82

Contributing

If you'd like to contribute to the Minds project, check out the Contribution section of Minds.org or head right over to the Minds Open Source Community. If you've found or fixed a bug, let us know in the Minds Help and Support Group!

Security reports

Please report all security issues to security@minds.com.

License

AGPLv3. Please see the license file of each repository.

Credits

PHP, Cassandra, Angular2, Nginx, Ubuntu, OpenSSL, RabbitMQ, Elasticsearch, Cordova, Neo4j, Elgg, Node.js, MongoDB, Redis, WebRTC, Socket.io, TinyMCE, Ionic, Requirejs, OAuth, Apigen). If any are missing please feel free to add.

Copyright Minds 2012 - 2023

Copyright for portions of Minds are held by Elgg, 2013 as part of the Elgg project. All other copyright for Minds is held by Minds, Inc.