Install Exot
Exot is a PWA and requires Docker.
1. Run in your CLI
curl -sSL https://exot.app/install.sh | bash
2. Register User
The docker container will output a user registration link (e.g. http://localhost:8080/api/v1/auth/register/...). Open the link in your browser and register the first admin user.
3. Access the App
The default address of the UI is http://localhost:8080/app
1. Requirements
- Docker
- Optionally MySQL server (Exot uses SQLite by default)
2. Configure
Create a file config.hjson
with the following content and replace the credentials:
mailer: {
sender: [email protected]
transport: sendmail
transportOptions: {
// (optional) Transport options (see for SMTP https://nodemailer.com/smtp/)
auth: {
user: null
pass: null
}
host: null
port: 465
secure: true
}
}
jwt: {
// JWT expiration time (e.g. 30d)
expiresIn: 90d
// JWT secret key
secret: SOME_SECRET
}
oauth: {
google: {
clientID: null
clientSecret: null
}
slack: {
clientID: null
clientSecret: null
}
}
passwordless: {
secret: null
}
database: {
// Driver type (sqlite or mysql)
type: sqlite
// TypeORM connection options (see https://typeorm.io/#/connection-options)
connectionOptions: {
// SQLite filaname or MySQL database name
database: ./exot.db
// disable or enable typeorm logging
logging: false
}
}
server: {
// Server address <host>:<port>; Use 0.0.0.0 for any IP address.
bind: 0.0.0.0:8080
// Server name
name: Exot
// (optional) URL address of the server to which the clients should connect to. Use if the server is behind a gateway.
publicUrl: null
// (optional) Rate limiting
rateLimit: {
// window size in miliseconds (10 minutes)
windowMs: 600000
// max number of requests per IP
max: 1200
}
}
3. Run Docker container
docker run \
-p 8080:8080 \
-v $(pwd):/etc/exot/data \
wiry/exot
The command above will download and run the Exot container on the default port 8080
with a
persistent data folder bound to your local PWD
.
The configuration file config.hjson
must be placed in your PWD
.
4. Register User
The docker container will output a user registration link (e.g. http://localhost:8080/api/v1/auth/register/...). Open the link in your browser and register the first admin user.
5. Access the App
The default address of the UI is http://localhost:8080/app