Rapptz / jimaku

A site for hosting (Japanese) subtitles
https://jimaku.cc
GNU Affero General Public License v3.0
60 stars 3 forks source link

jimaku (字幕)

jimaku is a simple site dedicated to hosting Japanese subtitles of anime or other Japanese content. It's the spiritual successor of kitsunekko.

Install

Right now, Rust v1.74 or higher is required. To install just run cargo build.

In order to actually run the server the static directory needs to be next to the executable. Maybe in the future there'll be a way to automatically move it.

In order to create an admin account, run the admin subcommand.

Configuration

Configuration is done using a JSON file. The location of the configuration file depends on the operating system:

The documentation for the actual configuration options is documented in the source code.

Data and Logs

The server also contains a database and some logs which are written to different directories depending on the operating system as well:

For data it is as follows:

For logs it is as follows:

The data directory contains both a database and a secluded managed "trash" directory.

Fixtures

Since this site is made to be a replacement for kitsunekko, it has support for scraping and then loading the data to this server. In order to do this initially, a bootstrapping phase is necessary where it downloads all the files necessary and then generates a fixture.json file.

This fixture.json file essentially has all the data that was scraped in a format that the program can understand when loaded using the fixtures subcommand. This flow allows you to edit the data in a way without committing it to the database yet.

Long Term Scraping

As a temporary migration period, this program supports periodically scraping from kitsunekko to get the newest data uploaded in a similar manner to the fixtures and scrape subcommands. Currently this is set to every hour.

License

AGPL-v3.