NeoAnd/evolution-manager
1
0
Fork 0
mirror of https://github.com/EvolutionAPI/evolution-manager.git synced 2025-07-13 15:14:49 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Gabriel Pastori 2023-11-14 19:40:06 -03:00 committed by GitHub
parent f12e3b2b8e
commit a9c70fd17b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -38,14 +38,39 @@ yarn build
```
This will create a `dist` folder with the compiled assets.
## Self-Hosted Instructions (Ubuntu Server)
1. **Prepare the Environment**: Install Node.js, Yarn, and any other necessary dependencies on your Ubuntu server.
2. **Clone and Build**:
- Clone the repository and build the project using the steps provided in the Development Setup section.
3. **Deploy**:
- Host the contents of the `dist` folder on your web server.
- Ensure the server is configured with an SSL certificate for secure access.
## Self-Hosted - Evolution Manager CLI and PM2
### Installation and Configuration
1. **Install Evolution Manager Globally**:
- Ensure Node.js and NPM are installed on your system.
- Install Evolution Manager globally using NPM to access the CLI (Command Line Interface):
```bash
npm install -g evolution-manager
```
2. **Using the CLI**:
- After installation, access the CLI commands by typing `evolution-manager` in your terminal.
- Available commands include:
- `help`: Displays a list of available commands and their descriptions.
- `server`: Server-related operations.
- `start [--port=9615]`: Starts the server on the specified port (default: 9615).
- `build`: Builds the project.
- `pm2`: Manages the process with PM2.
- `setup`: Sets up PM2 for the project.
- `start`: Starts the service with PM2.
- `stop`: Stops the service in PM2.
- `restart`: Restarts the service in PM2.
- `delete`: Removes the service from PM2.
3. **Running the Project with PM2**:
- To set up and manage the service with PM2, start with the setup command:
```bash
evolution-manager pm2 setup
```
- Then, you can start, stop, restart, or delete the service using the respective `pm2` commands in the CLI.
These instructions provide a streamlined method for managing Evolution Manager across various systems, utilizing PM2 for efficient service start-up, maintenance, and control.
## Contributing
Contributions are welcome! Please read our contributing guidelines to get started.