To set up the for development
yarn this will install all the dependencies
yarn start to create start the serve
To generate new posts
yarn posts [title]This will create a new post in
To generate new pages:
yarn page [title]this will create a new page in
To edit the sidebar:
themes/redbrick-theme/_config.yaml- this is where all the theme configuration is controlled from.
docker-compose.yml for development.
yarn start. This will create a server that runs on
yarn hexo. This will create a server that runs on
Analytics can be enabled by adding your analytics key to
To deploy to a server run:
yarnthis will install all the dependencies
yarn generateto create initial site
systemctl start websiteto start the express server
You will also need to create three files:
mailing_lista newline-separated list of email addresses
email_update_loga newline-separated reverse-chronological list of times email updates were sent
.env.exampleand modifying values (important)
email_update_log can be left blank, though updates for every post in history
will be sent if no previous send date is specified.
Then using apache or nginx proxy traffic to port 3000.
To use docker in production theres a
docker-compose.yml in the production folder.
.envrelative to the
mailing_listand add email addresses for announce
docker-compose up -d
hexo generateand send emails for any new posts so long as that process is not already underway.
To use sendmail rather then SMTP in the
To disable auth on SMTP leave
auth.pass as empty.
Modify the host, and port options as needed for SMTP either in the config or using the env variables.
||API key for regenerating the site|
||Recaptcha server key from Google|
||Recaptcha site key same as the on in the theme|
||When to rotate logs|
||SMTP host address|
||SMTP port for server|
||if using SSL or not|
||redbrick username for SMTP auth leave off the
||auth method to use with SMTP. Defaults to plain|
||port to run the server on defaults to 3000|
Official website of DCU Redbrick Society.
Copyright (C) 2017 Redbrick and all contributors.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.