diff --git a/README.md b/README.md index 693e196..b5cf0db 100644 --- a/README.md +++ b/README.md @@ -1,133 +1,128 @@  

Write Freely

Latest release Go Report Card Build status #writefreely on freenode

  WriteFreely is a beautifully pared-down blogging platform that's simple on the surface, yet powerful underneath. It's designed to be flexible and share your writing widely, so it's built around plain text and can publish to the _fediverse_ via ActivityPub. It's easy to install and lightweight. **[Start a blog on our instance](https://write.as/new/blog/federated)** [Try the editor](https://write.as/new) [Find another instance](https://writefreely.org/instances) ## Features * Start a blog for yourself, or host a community of writers * Form larger federated networks, and interact over modern protocols like ActivityPub * Write on a dead-simple, distraction-free and super fast editor * Publish drafts and let others proofread them by sharing a private link * Build more advanced apps and extensions with the [well-documented API](https://developers.write.as/docs/api/) ## Quick start > **Note** this is currently alpha software. We're quickly moving out of this v0.x stage, but while we're in it, there are no guarantees that this is ready for production use. First, download the [latest release](https://github.com/writeas/writefreely/releases/latest) for your OS. It includes everything you need to start your blog. Now extract the files from the archive, change into the directory, and do the following steps: ```bash # 1) Log into MySQL and run: # CREATE DATABASE writefreely; # # 2) Configure your blog ./writefreely --config # 3) Import the schema with: ./writefreely --init-db # 4) Generate data encryption keys ./writefreely --gen-keys # 5) Run ./writefreely # 6) Check out your site at the URL you specified in the setup process # 7) There is no Step 7, you're done! ``` For running in production, [see our guide](https://writefreely.org/start#production). ## Development Ready to hack on your site? Here's a quick overview. ### Prerequisites * [Go 1.10+](https://golang.org/dl/) * [Node.js](https://nodejs.org/en/download/) ### Setting up ```bash go get github.com/writeas/writefreely/cmd/writefreely ``` Configure your site, create your database, and import the schema [as shown above](#quick-start). Then generate the remaining files you'll need: ```bash make install # Generates encryption keys; installs LESS compiler make ui # Generates CSS (run this whenever you update your styles) 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. -``` -environment: - - MYSQL_ROOT_PASSWORD=changeme -``` +*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.* -After that, you can spin up the containers and configure them: +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. -```bash -# 1) Spin up the DB and Write Freely +``` 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 +Now you should be able to navigate to http://localhost:8080 and start working! -# 5) Migrate the database -mysql -u root -p writefreely < /tmp/schema.sql -exit +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. -# 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 -``` +### Using Docker for Production -Now you should be able to navigate to http://localhost:8080 and start blogging! +Write Freely doesn't yet provide an official Docker pathway to production. We're +working on it, though! ## License Licensed under the AGPL. diff --git a/config.ini.example b/config.ini.example new file mode 100644 index 0000000..10661bc --- /dev/null +++ b/config.ini.example @@ -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 + diff --git a/docker-compose.yml b/docker-compose.yml index 8284636..29a841e 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,30 +1,32 @@ version: "3" services: web: build: . volumes: - "web-data:/go/src/app" + - "./config.ini.example:/go/src/app/config.ini" ports: - "8080:8080" networks: - writefreely depends_on: - db restart: unless-stopped db: image: "mariadb:latest" volumes: - "./schema.sql:/tmp/schema.sql" - db-data:/var/lib/mysql/data networks: - writefreely environment: + - MYSQL_DATABASE=writefreely - MYSQL_ROOT_PASSWORD=changeme restart: unless-stopped volumes: web-data: db-data: networks: writefreely: diff --git a/docker-setup.sh b/docker-setup.sh new file mode 100755 index 0000000..46f41f3 --- /dev/null +++ b/docker-setup.sh @@ -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 \ No newline at end of file