Improve documentation for installation

This commit is contained in:
2024-11-22 14:13:39 +01:00
parent f1e5ccd432
commit 81da34f1b6
5 changed files with 490 additions and 427 deletions

View File

@@ -10,97 +10,6 @@ Chill-bundles is a set of bundles that should be used within a Symfony applicati
A symfony application will help you to customize all the configuration options, change the behaviour of some parts of the usual-way that chill works, … without to have to fork this repository !
### For a usage in production
See [the instructions in the docs](./docs/source/installation/index.rst).
You will create a symfony app, which will then download this bundle as a dependency.
See the documentation at https://docs.chill.social.
### For development or testing purpose only
⚠️ Use this method for development only. ⚠️
You will need:
- [Composer](https://getcomposer.org);
- [Symfony-cli tool](https://symfony.com/download);
- [docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/)
- node > 20 and yarn 1.22
#### First initialization
1. clone this repository and move to the cloned directory:
```bash
git clone https://gitlab.com/Chill-Projet/chill-bundles.git
cd chill-bundles
```
2. install depencies using composer
```bash
composer install
```
3. Install and compile assets:
```bash
yarn install
yarn run encore production
```
**note** double check that you have the node version > 20 using the `node --version` command.
4. configure your project: create a `.env.local` file at the root, and add the admin password:
```dotenv
# for this installation mode, the environment should always be "dev"
APP_ENV=dev
ADMIN_PASSWORD=\$2y\$13\$iyvJLuT4YEa6iWXyQV4/N.hNHpNG8kXlYDkkt5MkYy4FXcSwYAwmm
# note: if you copy-paste the line above, the password will be "admin".
```
5. start the stack using `docker compose up -d`, check the status of the start with `docker compose ps`
6. configure all the needed third-party tools
```bash
# the first start, it may last some seconds, you can check with docker compose ps
# run migrations
symfony console doctrine:migrations:migrate
# setup messenger
symfony console messenger:setup-transports
# prepare some views
symfony console chill:db:sync-views
# generate jwt token, required for some api features (webdav access, ...)
symfony console lexik:jwt:generate-keypair
```
7. add some fixtures
This will truncate all the existing data of the database. But remember, we are in dev mode !
```bash
symfony console doctrine:fixtures:load
```
8. launch symfony dev-server
```bash
symfony server:start -d
```
And visit the web page it suggest. You can login with user `center a_social` and password `password`, or login `admin` with the password you set.
#### Stopping the server
```bash
symfony server:stop
```
#### Restart the webserver for subsequent start
```bash
symfony server:start -d
# this will automatically starts the full docker compose services
```
## Documentation
The online documentation can be read at https://docs.chill.social, or the [`docs`][1] directory.
[1]: docs/README.md
Those instructions are also built [online](https://docs.chill.social).