update README.md

simple introduction
This commit is contained in:
philbob 2024-11-01 16:10:03 +00:00
parent 359804d0c0
commit af59c4f65f
1 changed files with 38 additions and 1 deletions

View File

@ -1,3 +1,40 @@
# vikunja_af2c
preparing to self-host vikunja task software for people in af2c.org
dependencies (for debian):
what I've installed:
docker-clean/stable,now 2.0.4-5 all [installed]
docker-compose/stable,now 1.29.2-3 all [installed]
docker-doc/stable,now 20.10.24+dfsg1-1 all [installed]
docker-registry/stable,now 2.8.2+ds1-1 amd64 [installed]
docker.io/stable,now 20.10.24+dfsg1-1+b3 amd64 [installed]
docker/stable,now 1.5-2 all [installed]
how to start this mess:
1: prepare directory for project
mkdir -p ~/vikunja/files ~/vikunja/db
2: assign privileges:
chown 1000 ~/vikunja/files ~/vikunja/db
3: make docker-compose.yml in vikuna directory
touch docker-compose.yml
4: edit docker-compose.yml
(I will give docker-compose.yml)
5: everything set up? start container(s) in vikunja directory
sudo docker-compose up
you can connect it with localhost
troubleshooting:
https://vikunja.io/docs/docker-walkthrough#troubleshooting
if you have "orphans containers" after making changes in docker-compose.yml, use: docker-compose down --remove-orphans
help welcomed
if you have any question, review or you want to contribute, make issue, pull request or DM me on matrix