Diurnum

A package of webservices intended to organize content for graduation newspapers. It contains:

• a Nextcloud Instance for collaborative work
• a web app for submitting quotes and characteristics

Setup

1. Install Docker and Docker Compose
2. Clone the repo
3. Change the default branding/localization to one that fits your own by editing the files in src/views
4. Add your own class and people data in src/data according to the example files
5. Rename .env.example to .env and enter your values with the exception of CHAR_FOLDER, NEXTCLOUD_BOT_USERNAME and NEXTCLOUD_BOT_PASSWORD
6. Run docker compose build && docker compose up -d
7. Setup a reverse proxy like nginx
   • It should map the endpoints of both of the docker containers to different base paths or subdomains
   • It should serve assets (favicon, shortcut image, background image) under /img/
8. Access your Nextcloud instance via the browser and configure everything.
9. Add a second user to your Nextcloud instance for the app container to use
10. Run docker compose down
11. Add the new nextcloud credentials to the .env file
12. Enter the domain the Nextcloud instance is accessible under and its container name to the Trusted Domains property in the config.php file in the Nextcloud volume
13. Run docker compose build && docker compose up -d

Code Generation

To generate codes for the characteristics submission system, use Diurnum Codegen

License

This software is published under the General Public License V3