mirror of
https://github.com/writefreely/writefreely
synced 2024-11-10 03:24:11 +00:00
Improved the Docker dev workflow slightly.
This commit is contained in:
parent
8e6d0daa06
commit
2de37a4ddb
4 changed files with 57 additions and 30 deletions
55
README.md
55
README.md
|
@ -90,43 +90,38 @@ make ui # Generates CSS (run this whenever you update your styles)
|
||||||
make run # Runs the application
|
make run # Runs the application
|
||||||
```
|
```
|
||||||
|
|
||||||
### Using Docker
|
## Docker
|
||||||
|
|
||||||
From the cloned git repository, you can quickly stand up a Write Freely instance with Docker and Docker Compose.
|
### Using Docker for Development
|
||||||
|
|
||||||
First, you'll need to change the password for MariaDB's root user in `docker-compose.yml` from `changeme` to something that is unique to your setup:
|
If you'd like to use Docker as a base for working on a site's styles and such,
|
||||||
|
you can run the following from a Bash shell.
|
||||||
|
|
||||||
|
*Note: This process is intended only for working on site styling. If you'd
|
||||||
|
like to run Write Freely in production as a Docker service, it'll require a
|
||||||
|
little more work.*
|
||||||
|
|
||||||
|
The `docker-setup.sh` script will present you with a few questions to set up
|
||||||
|
your dev instance. You can hit enter for most of them, except for "Admin username"
|
||||||
|
and "Admin password." You'll probably have to wait a few seconds after running
|
||||||
|
`docker-compose up -d` for the Docker services to come up before running the
|
||||||
|
bash script.
|
||||||
|
|
||||||
```
|
```
|
||||||
environment:
|
|
||||||
- MYSQL_ROOT_PASSWORD=changeme
|
|
||||||
```
|
|
||||||
|
|
||||||
After that, you can spin up the containers and configure them:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 1) Spin up the DB and Write Freely
|
|
||||||
docker-compose up -d
|
docker-compose up -d
|
||||||
|
./docker-setup.sh
|
||||||
# 2) Connect to MariaDB container
|
|
||||||
docker-compose exec db /bin/sh
|
|
||||||
|
|
||||||
# 3) Log in to MariaDB, using the password you specified in docker-compose.yml
|
|
||||||
mysql -u root -p
|
|
||||||
|
|
||||||
# 4) Create the database for Write Freely
|
|
||||||
CREATE DATABASE writefreely;
|
|
||||||
exit
|
|
||||||
|
|
||||||
# 5) Migrate the database
|
|
||||||
mysql -u root -p writefreely < /tmp/schema.sql
|
|
||||||
exit
|
|
||||||
|
|
||||||
# 6) Generate the configuration and clean up
|
|
||||||
docker-compose run web writefreely --config
|
|
||||||
docker stop writefreely_web_run_1 && docker rm writefreely_web_run_1
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you should be able to navigate to http://localhost:8080 and start blogging!
|
Now you should be able to navigate to http://localhost:8080 and start working!
|
||||||
|
|
||||||
|
When you're completely done working, you can run `docker-compose down` to destroy
|
||||||
|
your virtual environment, including your database data. Otherwise, `docker-compose stop`
|
||||||
|
will shut down your environment without destroying your data.
|
||||||
|
|
||||||
|
### Using Docker for Production
|
||||||
|
|
||||||
|
Write Freely doesn't yet provide an official Docker pathway to production. We're
|
||||||
|
working on it, though!
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
26
config.ini.example
Normal file
26
config.ini.example
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
[server]
|
||||||
|
hidden_host =
|
||||||
|
port = 8080
|
||||||
|
|
||||||
|
[database]
|
||||||
|
type = mysql
|
||||||
|
username = root
|
||||||
|
password = changeme
|
||||||
|
database = writefreely
|
||||||
|
host = db
|
||||||
|
port = 3306
|
||||||
|
|
||||||
|
[app]
|
||||||
|
site_name = Write Freely Example Blog!
|
||||||
|
host = http://localhost:8080
|
||||||
|
theme = write
|
||||||
|
disable_js = false
|
||||||
|
webfonts = true
|
||||||
|
single_user = true
|
||||||
|
open_registration = false
|
||||||
|
min_username_len = 3
|
||||||
|
max_blogs = 1
|
||||||
|
federation = true
|
||||||
|
public_stats = true
|
||||||
|
private = false
|
||||||
|
|
|
@ -4,6 +4,7 @@ services:
|
||||||
build: .
|
build: .
|
||||||
volumes:
|
volumes:
|
||||||
- "web-data:/go/src/app"
|
- "web-data:/go/src/app"
|
||||||
|
- "./config.ini.example:/go/src/app/config.ini"
|
||||||
ports:
|
ports:
|
||||||
- "8080:8080"
|
- "8080:8080"
|
||||||
networks:
|
networks:
|
||||||
|
@ -19,6 +20,7 @@ services:
|
||||||
networks:
|
networks:
|
||||||
- writefreely
|
- writefreely
|
||||||
environment:
|
environment:
|
||||||
|
- MYSQL_DATABASE=writefreely
|
||||||
- MYSQL_ROOT_PASSWORD=changeme
|
- MYSQL_ROOT_PASSWORD=changeme
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|
||||||
|
|
4
docker-setup.sh
Executable file
4
docker-setup.sh
Executable file
|
@ -0,0 +1,4 @@
|
||||||
|
#!/bin/bash
|
||||||
|
docker-compose exec db sh -c 'exec mysql -u root -pchangeme writefreely < /tmp/schema.sql'
|
||||||
|
docker exec writefreely_web_1 writefreely --gen-keys
|
||||||
|
docker exec -it writefreely_web_1 writefreely --config
|
Loading…
Reference in a new issue