efa2dd0d17
The documentation was imported from the former wallabag/doc repository.
We imported the documentation with:
git subtree add --prefix=doc <path-or-url-to-wallabag/doc> master
A one-pass equivalent cleanup for imported commit messages was then:
python3 git-filter-repo \
--message-callback 'return re.sub(br"(?<![/\w])#(\d{1,3})(?!\d)", br"https://github.com/wallabag/doc/pull/\1", message)' \
--refs master..chore/merge-doc-into-monorepo \
--force
The rewrite approach was inspired by https://web.archive.org/web/20241208191856/https://aaronhe.org/git-filter-repo-to-rewrite-commit-history.
git-subtree-dir: doc
git-subtree-mainline: 6c48d72c64
git-subtree-split: 04f0bd51cc
2.0 KiB
title, weight
| title | weight |
|---|---|
| Docker | 2 |
Run wallabag in docker-compose
This document describes how to use Docker for wallabag development purposes. For running wallabag in production, please use the official docker-compose configuration provided.
To run your own development instance of wallabag, you can use the pre-configured docker compose files provided in the wallabag repository.
Requirements
Make sure to have Docker and Docker Compose available on your system and up to date.
Switch DBMS
By default, wallabag starts with a SQLite database. However, wallabag also supports PostgreSQL and MySQL. Docker containers are available for both.
In compose.yaml (or docker-compose.yml for wallabag < 2.7), for the chosen DBMS uncomment:
- the container definition (
postgresormariadbroot level block) - the container link in the
phpcontainer - the container env file in the
phpcontainer
In order to keep running Symfony commands on your host (such as
wallabag:install), you also should:
- source the proper env files on your command line, so variables like
SYMFONY__ENV__DATABASE_HOSTwill exist. - create a
127.0.0.1 rdbmson your systemhostsfile
Run wallabag
- Fork and clone the project
- Edit
app/config/parameters.ymlto replacedatabase_*properties with commented ones (with values prefixed byenv.) composer installthe project dependenciesphp bin/console wallabag:installto create the schemadocker compose upto run the containers (ordocker-compose upfor wallabag < 2.7)- Finally, browse to http://localhost:8080/ to find your freshly installed wallabag.
At various step, you'll probably run into UNIX permission problems, bad paths in generated cache, etc… Operations like removing cache files or changing files owners might be frequently required, so don't be afraid!