Caution
This project is still in an experimental state and may be unstable. Proceed at your own risk.
If you'd prefer to use Docker instead of installing it manually, see the instructions here.
Note
This tutorial assumes you are using Linux and plan on installing MangAdventure under /var/www/my-site.com/
. The instructions are similar for Windows and MacOS.
First, you will need Python (3.7+) and pip.
Then, set up a virtualenv for MangAdventure with the following commands:
# This will install a virtualenv under /var/www/my-site.com/
python3 -m venv /var/www/my-site.com/
# This will activate the virtualenv
source /var/www/my-site.com/bin/activate
# You may need to install wheel manually
pip install wheel
Finally, install MangAdventure inside the activated virtualenv:
pip install -e "git+https://github.com/mangadventure/MangAdventure@v0.8.5#egg=mangadventure"
MangAdventure also provides the following extras:
mysql
: MySQL database supportpgsql
: PostgreSQL database supportcsp
: Content-Security-Policy headerssentry
: Sentry error reportinguwsgi
: uWSGI application server
For example, you can install csp
& uwsgi
like so:
pip install -e "git+https://github.com/mangadventure/MangAdventure@v0.8.5#egg=mangadventure[csp,uwsgi]"
Before proceeding, there are some settings you will need to configure. To configure them, copy the .env.example
file to .env
and edit it.
You can also override the styling of the site by writing some SCSS (or regular CSS) in the static/extra/style.scss
file.
This command will set up the database for your site.
mangadventure migrate
This command will collect the static files into static/
.
mangadventure collectstatic
You will be prompted for a name, email, and password. This account is needed to access the /admin-panel/
page. You can create multiple administrator accounts.
mangadventure createsuperuser
If you want to load an initial set of manga categories imported from MangaUpdates, run this command:
mangadventure loaddata categories
If you weren't using FoolSlide2 before, feel free to skip to the next section.
Limitations
- Series will be imported without authors & artists.
- Users & team members will not be imported.
- Chapters with multiple teams will be imported without the teams.
- Languages are not yet supported and thus cannot be imported.
- This has only been tested with FoolSlide2 v2.3.3 using a MySQL database.
First, export the data from FoolSlide2:
- Visit your site's
phpMyAdmin
page. - Click on your FoolSlide2 database.
- Go to the
Export
tab. - In
Format:
selectXML
and clickGo
. - Save the generated file somewhere and copy its path.
Next, import the data into MangAdventure:
- Replace
{root}
with the path to your FoolSlide2 installation. - Replace
{data}
with the path to the XML file you exported.
mangadventure fs2import "{root}" "{data}"
Make sure the user running the web server and
uwsgi
has the necessary permissions to access all the relevant files.Also, create the
media
and log
directories beforehand to avoid possible permission errors.Lastly, don't forget to run
uwsgi
after setting up the server:(For more details, check the uWSGI docs.)
uwsgi --socket "127.0.0.1:25432" --chdir "/var/www/my-site.com" --module "MangAdventure.wsgi"
Apache requires mod_uwsgi.
examples/apache.conf
Nginx requires uwsgi.
examples/nginx.conf
# Don't forget to activate the virtualenv
source /var/www/my-site.com/bin/activate
pip install -U -e "git+https://github.com/mangadventure/MangAdventure@{tag}#egg=MangAdventure"
Then, check .env.example
for new variables. If there are any, set them in .env
.
Finally, update the database:
mangadventure migrate