Megumin fansite!
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
legacy_upgrade
src
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.htmlhintrc
.travis.yml
LICENSE.md
README.md
Upgrading.md
Wiki-Api.md
minifyAssets.js
package.json

README.md

Original: https://megumin.love

Megumin.love

Build Status

A site committed to worshipping best girl Megumin!

Runs on NodeJS mainly with Express, SQLite3 and uws.

Self-hosting Usage

  • Navigate into the folder you downloaded the repo to
  • Rename src/config.sample.json to src/config.json
  • Recommended, but not needed: Rename src/db/default.db to a name of your choosing (take care to change the config appropriately)
    • Your database may be overwritten by the default one if you keep the default filename and try updating the website in the future.
  • Open the config.json file and configure the website's settings (Make sure to change the admin token and session secret)
  • Run npm install in a terminal to install dependencies
  • Navigate into the src folder (to set the working directory properly)
  • Start the website using node server.js (or pm2 start server.js if you use pm2)
  • Click!

Updating the website

  • Always check by the Upgrading file for instructions on adding new sounds and migration notices.
  • In addition, read the relevant release notes in the GitHub releases section.

Adding custom sounds

There are two ways to add custom sounds starting with version 5.0.0 -- via interface or manually. If done via interface then no restart is required, if done manually changes only take effect on restart.

Interface:

  1. Open the admin panel at the /admin page and log in
  2. Fill out the form for uploads on the very left and click "Upload sound"

Manually:

  1. Put your new sound files in the src/resources/sounds/ folder (in ogg and mp3 format)
  2. Run this query with the values you want to use for the sound:
    • INSERT INTO sounds ( filename, displayname, source, count ) VALUES ( <your>, <values>, <here>, 0 );
  3. Restart the website

Renaming sounds

Interface:

  1. Open the admin panel at the /admin page and log in
  2. Fill out the form for renaming in the center and click "Update sound".

Manually:

  1. Rename the files in the src/resources/sounds folder
  2. Run this query with with the new values you want to use for the sound:
    • UPDATE sounds SET filename = <your>, displayname = <values>, source = <here> WHERE filename = <old filename>;
  3. Restart the website

Removing sounds

Interface:

  1. Open the admin panel at the /admin page and log in.
  2. Fill out the form for deletion to the right and click "Delete sound"

Manually:

  1. Delete the files in the src/resources/sounds folder
  2. Run this query with with the value for the sound you want to delete:
    • DELETE FROM sounds WHERE filename = <your value here>;
  3. Restart the website

Important Information

  • Using the master branch instead of releases does not guarantee receiving a working version of the website. I work on the site on my own pace and don't always update the master branch to a working state (especially when i am working on new features), so if you want a version that's guaranteed to work, use a release version -- optimally the latest.

  • If upgrading to a new version (especially a new major, e.g. 4.x -> 5.x), be sure to check if the release notes mention anything regarding changes that need to be made to the database as well as having a look at the Upgrading page. If something like that is needed instructions on how to adjust the database will be given, be sure to follow those.

  • If you add to the errorTemplates, you will have to create the actual html files for these in the src/pages/errorTemplates/ folder as well, otherwise this setting will not take effect.

  • Update interval in the config represents minutes, following the cronjob syntax, so the max value is 60 (meaning once every hour).

    • 1 would mean once every minute, 10 once every 10 minutes etc. Commas will be rounded (this is due to scheduling).
  • It is also advised to check out the Wiki for more information.

  • uws version 10.148.1 or earlier needs to be installed as newer versions are blank repos. No support provided for cases where versions later than 10.148.1 are installed.

Important for proxying to 443 (SSL)

If you want to proxy the website to the SSL port (443), so that users can access the site via https://<domain> instead of http://<domain>:<port>, then flip on the SSLproxy setting in the config. This will make the front-end WebSocket connections connect to wss://<domain> instead of ws://<domain>:<port>. Not changing this setting but still proxying to the SSL port (443) will result in every counter of the page being unresponsive, as the WebSocket connections will fail.

If you're not going to be running the site with SSL just leave the setting at the default false value and everything should be fine.

Nginx proxy example:

server {
    # Proxy-unrelated settings left out

    location / {
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $host;
        proxy_set_header X-NginX-Proxy true;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_http_version 1.1;
        proxy_pass http://127.0.0.1:<port>;
        proxy_store off;
        proxy_redirect off;
    }
}

I used to have an Apache example too, but I couldn't figure out how to get it working after switching to uws, so i removed it instead of providing false info. Apologies for those who need it.

You will have to insert the port you chose in the src/config.json file in place of the <port> placeholders here.

License

Licensed under the MIT License.