https://github.com/schooloffreelancing/mind
mind
https://github.com/schooloffreelancing/mind
Last synced: 2 days ago
JSON representation
mind
- Host: GitHub
- URL: https://github.com/schooloffreelancing/mind
- Owner: SchoolOfFreelancing
- License: other
- Created: 2019-12-22T20:47:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-22T20:51:06.000Z (over 5 years ago)
- Last Synced: 2025-01-17T19:12:07.435Z (5 months ago)
- Language: PHP
- Size: 216 MB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Minds
=====
Minds is an open-source, encrypted and reward-based social networking platform. https://minds.com
## Docs
Full documentation can be found at [https://developers.minds.com/](https://developers.minds.com/)
## Repositories
Minds is split into multiple repositories:
- [Engine](https://gitlab.com/minds/engine) - Backend code & APIs
- [Front](https://gitlab.com/minds/front) - Client side Angular2 web app
- [Sockets](https://gitlab.com/minds/sockets) - WebSocket server for real-time communication
- [Mobile](https://gitlab.com/minds/mobile-native) - React Native mobile apps
## Development System Requirements
- > 10GB RAM (be sure to set it in your docker settings)
- > 100GB Disk space
- [Docker Compose](https://docs.docker.com/compose/)
## Development Installation
**Enabling full installation**
### Setting up elasticsearch
** Linux users **
To get elasticsearch 6 to run, you must make a settings change on the host machine.
Run ```sudo sysctl -w vm.max_map_count=262144```
To make it permanent, modify the variable in /etc/sysctl.conf
#### Build the elasticsearch indexes
1. Make sure nothing is running: `docker-compose down`
2. Run the legacy provisioner: `docker-compose up elasticsearch-legacy-provisioner`
3. Run the legacy provisioner: `docker-compose up elasticsearch-provisioner`
### Running the stack the first time
1. Run `sh init.sh` in order to install the front and engine repositories
2. Run `docker-compose up -d nginx`
3. Run `docker-compose up installer` (one time only.. initial username: minds / password: Pa$$w0rd)
4. Run `docker-compose up front-build`
5. Navigate to `http://localhost:8080`
6. Run `docker-compose up sync-engine`to sync engine
7. Run `docker-compose up sync-front`
# Troubleshooting
- Minds is already installed
- Ensure engine/settings.php does not exist and re-run `docker-compose up installer`
- Cassandra will not boot
- Ensure thrift is enabled
- Cassandra requires at least 4GB of memory to operate. You can start Cassandra manually by running `docker-compose up cassandra`
### Nuclear Option
With dockerized enviroments, it's sometimes best to start from scratch. If you want to delete your data, these steps will completely **delete** your data. You will be starting fresh.
```
#Remove your settings file
rm engine/settings.php
#Stop your stack
docker-compose down
#Delete your data cache
rm -rf .data
#Purge all volumes
docker volume prune
```
That will remove all of your locally cached data. You can either rebuild the containers manually by using ```docker-compose up --build``` or delete everything to start fresh.
```
# Delete all containers
docker rm $(docker ps -a -q)
```
## Production System Requirements
At this time it is not advisable to run Minds in production, however it is possible so long as you are aware of the risks.
- 3 Cassandra Nodes (Min 30gb RAM, 1TB SSD, 8 CPU)
- 1 ElasticSearch Node (Min 16GB RAM, 250GB SSD, 8 CPU) #2 nodes are recommended for failover
- 1 Docker Machine (Min 60gb RAM, 50GB SSD, 32 CPU)
## Contributing
If you'd like to contribute to the Minds project, check out the [Contribution](https://www.minds.org/docs/contributing.html) section of Minds.org or head right over to the [Minds Open Source Community](https://www.minds.com/groups/profile/365903183068794880). If you've found or fixed a bug, let us know in the [Minds Help and Support Group](https://www.minds.com/groups/profile/100000000000000681/activity)!
## Security reports
Please report all security issues to [[email protected]](mailto:[email protected]).
## License
[AGPLv3](https://www.minds.org/docs/license.html). Please see the license file of each repository.
## Credits
[PHP](https://php.net), [Cassandra](http://cassandra.apache.org/), [Angular2](http://angular.io), [Nginx](https://nginx.com), [Ubuntu](https://ubuntu.com), [OpenSSL](https://www.openssl.org/), [RabbitMQ](https://www.rabbitmq.com/), [Elasticsearch](https://www.elastic.co/), [Cordova](https://cordova.apache.org/), [Neo4j](https://neo4j.com/), [Elgg](http://elgg.org), [Node.js](https://nodejs.org/en/), [MongoDB](https://www.mongodb.com/), [Redis](http://redis.io/), [WebRTC](https://webrtc.org/), [Socket.io](http://socket.io/), [TinyMCE](https://www.tinymce.com/), [Ionic](http://ionicframework.com/), [Requirejs](http://requirejs.org/), [OAuth](http://oauth.net/2/), [Apigen](http://www.apigen.org/), [Braintree](https://www.braintreepayments.com/). If any are missing please feel free to add.
___Copyright Minds 2012 - 2018___
Copyright for portions of Minds are held by [Elgg](http://elgg.org), 2013 as part of the [Elgg](http://elgg.org) project. All other copyright for Minds is held by Minds, Inc.