@@ -17,11 +17,9 @@ Before submitting an MR, make sure you have reviewed the [AGPLv3 license](contri
### Submitting an issue
If you want to contribute but aren't ready to work with the codebase, you can submit an issue [here](https://gitlab.com/groups/minds/-/issues) instead. If you have the required permissions, you can apply labels to a bug or feature yourself. If not, tag a [member of staff](https://gitlab.com/groups/minds/-/group_members) in a comment on the issue page (or post in the [Help & Support](https://www.minds.com/groups/profile/100000000000000681/feed) group) and we will take care of it as soon as possible.
In most cases, issues submitted by the community will either be bugs or feature requests, submitted [here](https://gitlab.com/groups/minds/-/issues). If you have the required permissions, you can apply labels to a bug or feature yourself. If not, tag a [member of staff](https://gitlab.com/groups/minds/-/group_members) in a comment on the issue page (or post in the [Help & Support](https://www.minds.com/groups/profile/100000000000000681/feed) group) and we will take care of it as soon as possible.
In most cases, issues submitted by the community will either be bugs or feature requests.
- log a **bug** when something has gone wrong in the system. Before you log a bug, search through existing issues to make sure it hasn't already been reported. Use the bug template and fill it out with as much information as possible - especially platform details and steps to reproduce. The more information we have, the more likely we will be able to replicate the problem and find a way to fix it.
- log a **bug** when something has gone wrong in the system. Before you log a bug, search through existing issues to make sure it hasn't already been reported. Use the bug template provided in GitLab and fill it out with as much information as possible - especially platform details and steps to reproduce. The more information we have, the more likely we will be able to replicate the problem and find a way to fix it.
- log a **feature request** to suggest we add something that doesn't already exist on the site. Be as descriptive as possible. We welcome mock-ups and even rough sketches in notebooks if they help illustrate your idea.
- 10GB RAM (also set this in _Docker > Settings > Advanced_ tab)
- 100GB Disk space
## Development Installation
### Build the elasticsearch indexes
### Build the Elasticsearch indexes
Make sure nothing is running:
```console
docker-compose down
```
Run the legacy provisioner:
```console
docker-compose up elasticsearch-legacy-provisioner
```
Run the legacy provisioner:
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`
```console
docker-compose up elasticsearch-provisioner
```
_**Linux users:** To get ElasticSearch 6 to run, you must make a settings change on the host machine:_
_**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`_
### Running the stack the first time
### Running the stack for 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)
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`
5. Navigate to [http://localhost:8080](http://localhost:8080)
## Troubleshooting
### Minds is already installed
- Ensure engine/settings.php does not exist and re-run `docker-compose up installer`
- Ensure **engine/settings.php** does not exist and re-run `docker-compose up installer`
### Cassandra will not boot
...
...
@@ -52,11 +66,11 @@ _**Linux users:** To get ElasticSearch 6 to run, you must make a settings change
### Docker is frozen
- You might need to increase the resources allotted to Docker. To do this, go to Docker > Preferences > Advanced. From there, move the CPU/Memory sliders up and see if that fixes the problem
- You might need to increase the resources allotted to Docker. To do this, go to _Docker > Preferences > Advanced_ . From there, move the CPU/Memory sliders up and see if that fixes the problem
### Nuclear Option
When things aren't running smoothly in your dockerized enviroment, sometimes it's best to start from scratch. Follow these steps to **completely delete your data** and start fresh:
When things aren't running smoothly in your Dockerized enviroment, sometimes it's best to start from scratch. Follow these steps to **completely delete your data** and start fresh:
```
#Remove your settings file
...
...
@@ -79,7 +93,7 @@ After you've deleted your data, you can either rebuild the containers manually b
docker rm $(docker ps -a -q)
```
## Production System Requirements
## 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.
...
...
@@ -89,7 +103,13 @@ At this time it is not advisable to run Minds in production, however it is possi
## Working in the development environment
- Configure your settings in `settings.php`
- To make your test user an admin,
- In `settings.php`, make sure you are in development mode: `$CONFIG->set('development_mode', false);`
- Change your test user entity `isAdmin` flag to true
Configure your settings in `settings.php`
To make your test user an admin:
Make sure you are in development mode in `settings.php`:
```php
$CONFIG->set('development_mode',true);
```
And set your test user entity's `isAdmin` flag to true.
