Skip to content

Commit a77bd14

Browse files
authored
PHRAS-4149 Update stack.md (#4616)
* Update stack.md * Update README.md
1 parent bd0b250 commit a77bd14

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,14 +206,16 @@ If you are not interested in the development of Phraseanet, you can ignore every
206206
### stack Management
207207

208208

209-
To start and stop the stack, use the `stack_management.sh start|stop|info|status|log` script at the project root.
209+
To start and stop the stack, use the
210+
`start|stop|status|version|maintenance [on|off]|logs [container_name]|apply-setup`
211+
script at the project root.
210212
this script work only Linux and MacOS.
211213

212214
This script wrapping standard oprations for the stack, using standard docker compose cmd and take in account `.env` and `env.local | .env.local` files.
213215

214216
This script is useful if you are using the database container within the stack.
215217

216-
see more here ![stack](doc/infra/compose/stack.md)
218+
More reading [here](doc/infra/compose/stack.md)
217219

218220
### Using a env.local method for custom .env values
219221

doc/infra/compose/stack.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ This script is an helper designed to manage a Phraseanet Docker compose stack by
99
## Features
1010

1111
- **Start and Stop the Docker Stack**: Easily start or stop your Docker stack with simple commands.
12-
- **Version Checking**: Verify the compatibility of Docker and Docker Compose versions.
12+
- **Version Checking**: Verify the compatibility of Docker and Docker Compose versions and display Phraseanet version.
1313
- **Environment Information**: Gather detailed information about the environment, including Phraseanet installation status, version details, and internal URLs.
1414
- **Log Viewing**: View logs for all containers or filter logs for a specific container.
15+
- **maintenance pages** enbaling or disabling.
1516

1617

1718
## Usage
@@ -34,14 +35,20 @@ This script is an helper designed to manage a Phraseanet Docker compose stack by
3435
./stack.sh stop
3536
```
3637

37-
- **Check Versions**:
38-
```bash
38+
- **View stack status**:
39+
- including:
40+
- Started containers
41+
- Containers's Started processus
42+
- RabbitMQ queues inventory
43+
- Db database and connection (works only with `db` profile)
44+
45+
```bash
3946
./stack.sh status
4047
```
4148

42-
- **Display Environment Information**:
49+
- **Display stack version Information and host environnement**:
4350
```bash
44-
./stack.sh info
51+
./stack.sh version
4552
```
4653

4754
- **View Logs**:
@@ -54,6 +61,16 @@ This script is an helper designed to manage a Phraseanet Docker compose stack by
5461
./stack.sh logs <container_name>
5562
```
5663

64+
- **activate Maintenance**:
65+
- enabled or disabled the maintenance page
66+
```bash
67+
./stack.sh maintenance <on|off>
68+
```
69+
- **apply-setup**:
70+
- start setup container for configuration change applying change
71+
```bash
72+
./stack.sh apply-status
73+
```
5774
### Environment Variables
5875

5976
The script uses the following environment variables, which should be defined in your environment files:

0 commit comments

Comments
 (0)