Compare commits
4 Commits
74dd21b953
...
main
Author | SHA1 | Date | |
---|---|---|---|
3cc1050007 | |||
e9a4d618d5 | |||
07f2ddd86d | |||
75b0d8389b |
54
BUILD.md
54
BUILD.md
@@ -1,54 +0,0 @@
|
|||||||
# Keila on Cloudron
|
|
||||||
|
|
||||||
This document provides instructions on how to build and install the Keila package for Cloudron.
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- A Cloudron instance
|
|
||||||
- Cloudron CLI installed and configured
|
|
||||||
- Docker installed locally
|
|
||||||
|
|
||||||
## Building the Package
|
|
||||||
|
|
||||||
The Keila Cloudron package is built using the `cloudron build` command. This command will use the `Dockerfile` to create a Docker image and push it to a Docker registry.
|
|
||||||
|
|
||||||
To build the package, run the following command in the root of this repository:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cloudron build --set-build-service builder.docker.due.ren --build-service-token e3265de06b1d0e7bb38400539012a8433a74c2c96a17955e --set-repository andreasdueren/keila-cloudron --tag 0.15.0
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `andreasdueren/keila-cloudron` with your own Docker Hub repository if you wish. The version `0.15.0` corresponds to the Keila version being packaged.
|
|
||||||
|
|
||||||
## Installing the Application
|
|
||||||
|
|
||||||
Once the build is complete, you can install the application on your Cloudron instance using the `cloudron install` command.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cloudron install --location keila.due.ren --image andreasdueren/keila-cloudron:0.15.0
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `keila.due.ren` with the desired location for your Keila instance.
|
|
||||||
|
|
||||||
## First-time Setup
|
|
||||||
|
|
||||||
After installation, Keila will be configured with the following settings:
|
|
||||||
|
|
||||||
- The root user is created with your Cloudron account's email address.
|
|
||||||
- To set your password for the first time, use the "Forgot Password?" link on the login page.
|
|
||||||
- Email sending is configured to use Cloudron's mail server.
|
|
||||||
- User-uploaded content is stored in `/app/data/uploads`.
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
You can view the application logs from the Cloudron dashboard or using the Cloudron CLI:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cloudron logs --app keila.due.ren
|
|
||||||
```
|
|
||||||
|
|
||||||
To get a shell inside the running application container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cloudron exec --app keila.due.ren
|
|
||||||
```
|
|
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 Andreas Dueren
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
Reference in New Issue
Block a user