Update README.md
This commit is contained in:
56
README.md
56
README.md
@@ -101,6 +101,7 @@ A feature-rich, production-ready chat server and client built with Python and We
|
|||||||
- **Optional (for Advanced Features)**:
|
- **Optional (for Advanced Features)**:
|
||||||
- `cryptography`: Required for End-to-End Encryption (E2EE)
|
- `cryptography`: Required for End-to-End Encryption (E2EE)
|
||||||
- `Pillow`: Required for ASCII Image Art features
|
- `Pillow`: Required for ASCII Image Art features
|
||||||
|
- `prompt-toolkit`
|
||||||
|
|
||||||
### Windows (Local Development)
|
### Windows (Local Development)
|
||||||
|
|
||||||
@@ -112,47 +113,16 @@ A feature-rich, production-ready chat server and client built with Python and We
|
|||||||
3. Edit `.env` file with your configuration
|
3. Edit `.env` file with your configuration
|
||||||
4. Start the server:
|
4. Start the server:
|
||||||
```cmd
|
```cmd
|
||||||
venv\Scripts\activate
|
|
||||||
python server.py
|
python server.py
|
||||||
```
|
```
|
||||||
5. In a new terminal, start the client:
|
5. In a new terminal, start the client:
|
||||||
```cmd
|
```cmd
|
||||||
venv\Scripts\activate
|
|
||||||
python client.py
|
python client.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### Ubuntu (Production Deployment)
|
|
||||||
|
|
||||||
1. Clone or download this repository
|
|
||||||
2. Make the deployment script executable:
|
|
||||||
```bash
|
|
||||||
chmod +x deploy_ubuntu.sh
|
|
||||||
```
|
|
||||||
3. Run the deployment script:
|
|
||||||
```bash
|
|
||||||
./deploy_ubuntu.sh
|
|
||||||
```
|
|
||||||
4. Follow the prompts to configure systemd service and firewall
|
|
||||||
5. Edit `.env` file with your production configuration
|
|
||||||
6. If using systemd, the server will start automatically
|
|
||||||
7. Otherwise, start manually:
|
|
||||||
```bash
|
|
||||||
source venv/bin/activate
|
|
||||||
python3 server.py
|
|
||||||
```
|
|
||||||
|
|
||||||
### Manual Installation
|
### Manual Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Create virtual environment
|
|
||||||
python3 -m venv venv
|
|
||||||
|
|
||||||
# Activate virtual environment
|
|
||||||
# On Windows:
|
|
||||||
venv\Scripts\activate
|
|
||||||
# On Linux/Mac:
|
|
||||||
source venv/bin/activate
|
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
|
||||||
@@ -230,11 +200,9 @@ Start the unified client:
|
|||||||
python client.py
|
python client.py
|
||||||
```
|
```
|
||||||
|
|
||||||
The client will prompt you to choose a mode:
|
The client will prompt you to choose a server:
|
||||||
1. **Central Server Mode**: Connect to a central server (ws://...)
|
1. On default it will say wss://server.wholeworldcoding.com/radio
|
||||||
2. **P2P LAN Mode**: Connect directly to peers on your local network
|
2. If you are running the server locally please type: ws:/localhost:8765
|
||||||
|
|
||||||
In **P2P Mode**, it will also ask for a port (80, 443, or custom) and automatically discover others in the same room on your LAN.
|
|
||||||
|
|
||||||
### File Sharing
|
### File Sharing
|
||||||
|
|
||||||
@@ -268,7 +236,7 @@ Type `/help` in the client to see all available commands.
|
|||||||
|
|
||||||
### Public Internet (Ubuntu Server)
|
### Public Internet (Ubuntu Server)
|
||||||
|
|
||||||
1. Use the deployment script: `./deploy_ubuntu.sh`
|
1. Deploy the server
|
||||||
2. Configure firewall to allow port 8765
|
2. Configure firewall to allow port 8765
|
||||||
3. Clients connect to: `wss://yourdomain.com:8765`
|
3. Clients connect to: `wss://yourdomain.com:8765`
|
||||||
|
|
||||||
@@ -305,26 +273,12 @@ radio/
|
|||||||
├── .env.example # Environment template
|
├── .env.example # Environment template
|
||||||
├── .env # Your configuration
|
├── .env # Your configuration
|
||||||
├── setup_windows.bat # Windows setup script
|
├── setup_windows.bat # Windows setup script
|
||||||
├── deploy_ubuntu.sh # Ubuntu deployment script
|
|
||||||
├── README.md # Main documentation
|
├── README.md # Main documentation
|
||||||
├── docs/ # Detailed documentation files
|
├── docs/ # Detailed documentation files
|
||||||
├── chat.db # SQLite database
|
├── chat.db # SQLite database
|
||||||
├── backups/ # Room backups directory
|
|
||||||
└── logs/ # Log files directory
|
└── logs/ # Log files directory
|
||||||
```
|
```
|
||||||
|
|
||||||
### Documentation Index
|
|
||||||
|
|
||||||
For more detailed information, please refer to the files in the `docs/` folder:
|
|
||||||
|
|
||||||
- **QUICKSTART.md**: Step-by-step guide for beginners
|
|
||||||
- **P2P_GUIDE.md**: In-depth guide for P2P and LAN communication
|
|
||||||
- **P2P_FEATURES.md**: Technical details of the P2P engine
|
|
||||||
- **IMPROVEMENTS.md**: Summary of latest optimizations and features
|
|
||||||
- **QUICK_REFERENCE.md**: Most common commands and tips
|
|
||||||
- **CHANGELOG.md**: Version history and future plans
|
|
||||||
- **FINAL_SUMMARY.md**: Overview of the unified chat system architecture
|
|
||||||
|
|
||||||
### Contributing
|
### Contributing
|
||||||
|
|
||||||
Contributions are welcome! Please fork the repository, create a feature branch, and submit a pull request.
|
Contributions are welcome! Please fork the repository, create a feature branch, and submit a pull request.
|
||||||
|
|||||||
Reference in New Issue
Block a user