https://github.com/altendorfme/alo
Alô is the open source alternative to OneSignal, PushNews, SendPulse, PushAlert, and others.
https://github.com/altendorfme/alo
firebase onesignal push push-notifications webpush webpush-notifications
Last synced: 3 months ago
JSON representation
Alô is the open source alternative to OneSignal, PushNews, SendPulse, PushAlert, and others.
- Host: GitHub
- URL: https://github.com/altendorfme/alo
- Owner: altendorfme
- License: mit
- Created: 2025-02-26T01:28:15.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-25T03:36:59.000Z (3 months ago)
- Last Synced: 2025-03-25T04:27:03.427Z (3 months ago)
- Topics: firebase, onesignal, push, push-notifications, webpush, webpush-notifications
- Language: PHP
- Homepage:
- Size: 2.03 MB
- Stars: 25
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Alô 🚀📬
[](https://github.com/altendorfme/alo/network/members)
[](https://github.com/altendorfme/alo/stargazers)
[](https://github.comaltendorfme/aloa/issues)
Alô is a tool for managing and registering Web Push notifications. It also provides features for campaign management, analytics, and user segmentation.
Alô is the open source alternative to OneSignal, PushNews, SendPulse, PushAlert, and others.
## Installation with Docker 🐳
Install [Docker and Docker Compose](https://docs.docker.com/engine/install/)
`curl -o ./docker-compose.yml https://raw.githubusercontent.com/altendorfme/alo/main/docker-compose.yml`
`curl -o ./.env https://raw.githubusercontent.com/altendorfme/alo/main/docker.env.example`
Edit environment:
`nano .env`
| Variable | Default | Description |
|----------|---------|-------------|
| TZ | UTC | Timezone for the application |
| WORKERS | 1 | Each worker is a push service, each worker sends 5-6 pushes per second. Increasing the number of workers will directly impact database usage. |
| AMQP_USER | Empty | Username for AMQP message broker authentication |
| AMQP_PASS | Empty | Password for AMQP message broker authentication |
| AMQP_VHOST | alo | Virtual host for AMQP to isolate applications |
| MYSQL_DATABASE | alo | Name of the MySQL database for alo |
| MYSQL_USER | alo | Username for MySQL database authentication |
| MYSQL_PASSWORD | Empty | Password for MySQL database authentication |
**AMQP**: RabbitMQ is used by default, but LavinMQ has also been tested and works correctly.
Now just run `docker compose up -d`
## First-Time Setup 🔧
1. Access the installation at `https://site.xyz/install`
2. Complete the initial configuration
3. Log in to the admin panel at `https://site.xyz/login`
## Who is using it?
- [Manual do Usuário](https://manualdousuario.net)
- [Catraca Livre](https://catracalivre.com.br)
## Alô SDK 📱
You'll need the alo Client SDK on all your pages:
```javascript
import aloClient from 'https://alo-server.xyz/clientSDK';
```
Just drop this in, and you're ready to roll! The SDK gets set up with different options depending on what you want to do with it.
### Automatic Subscription ⚡
This option will show the permission prompt after a short delay - no user clicks needed!
```javascript
const aloConfig = {
customSegments: {
tag: 'tag-teste-auto',
category: 'cat-teste-auto'
},
registrationMode: 'auto', // ← Magic happens here!
registrationDelay: 3000, // Just 3 seconds wait
enableLogging: true,
onRegistrationSuccess: () => {
alert('Push notification registration successful!');
},
onRegistrationError: (error) => {
alert('Registration failed: ' + error.message);
}
};
const aloClient = new aloClient(aloConfig);
```
The secret sauce here is `registrationMode: 'auto'` - this tells alo to automatically ask for permission. You can control how long to wait with the `registrationDelay` setting.
### Manual Subscription 👆
Prefer to let users decide when to subscribe? This approach requires a click before asking for permission.
```javascript
const aloConfig = {
customSegments: {
tag: 'tag-test-manual',
category: 'cat-test-manual'
},
registrationMode: 'manual', // ← User control!
enableLogging: true
};
const aloClient = new aloClient(aloConfig);
subscribeBtn.addEventListener('click', async () => {
try {
await aloClient.subscribe();
alert('Push notification subscription successful!');
subscribeBtn.disabled = true;
} catch (error) {
alert('Subscription failed: ' + error.message);
}
});
```
With `registrationMode: 'manual'`, alo waits patiently until you call `subscribe()`. Perfect for adding to a "Subscribe" button!
### Unsubscription 👋
Sometimes users want to say goodbye to notifications. Here's how to let them unsubscribe:
```javascript
const aloConfig = {
customSegments: {
tag: 'tag-test-unsubscribe',
category: 'cat-test-unsubscribe'
},
enableLogging: true
};
const aloClient = new aloClient(aloConfig);
unsubscribeBtn.addEventListener('click', async () => {
try {
await aloClient.unsubscribe();
alert('Push notification unsubscription successful!');
unsubscribeBtn.disabled = true;
} catch (error) {
alert('Unsubscription failed:' + error.message);
}
});
```
Just hook up an "Unsubscribe" button to the `unsubscribe()` method, and you're good to go!
### 🤖 Service Worker
Your notifications need a Service Worker to function even when users aren't on your site:
```javascript
importScripts('https://alo-server.xyz/serviceWorker');
```
Just put this in your `aloSW.js` file, and alo handles all the background notification magic for you! ✨
## API 📡
### Create Campaign
Creates a new campaign with `draft` status.
**URL**: `/api/campaign/create` (POST)
**Request Body**:
```json
{
"name": "My Campaign",
"push_title": "Check out our new feature!",
"push_body": "We've just launched something amazing you'll love.",
"push_icon": "https://example.com/icon.png",
"push_url": "https://example.com/landing",
"push_requireInteraction": true
}
```
**cURL Example**:
```bash
curl -X POST \
https://alo-server.xyz/api/campaign/create \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"name": "My Campaign",
"push_title": "Check out our new feature!",
"push_body": "We have just launched something amazing you will love.",
"push_icon": "https://example.com/icon.png",
"push_url": "https://example.com/landing"
}'
```
**Success Response**:
```json
{
"success": true,
"message": "Campaign created successfully",
"campaign": {
"id": 123,
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "My Campaign",
"push_title": "Check out our new feature!",
"push_body": "We have just launched something amazing you will love.",
"push_icon": "https://example.com/icon.png",
"push_url": "https://example.com/landing",
"status": "draft",
"created_at": "2025-03-05 13:58:45",
"updated_at": "2025-03-05 13:58:45"
}
}
```
**Error Response**:
```json
{
"error": "Field 'push_body' is required"
}
```
## Contributing 🤝
Made with ❤️! If you have questions or suggestions, open an issue and we'll help!