Skip to content

Commit f1f431a

Browse files
committed
Added docker files and docs
0 parents  commit f1f431a

File tree

9 files changed

+98
-0
lines changed

9 files changed

+98
-0
lines changed

.dockerignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.git
2+
node_modules
3+
coverage
4+
*nyc*

Dockerfile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
FROM webdevops/php-apache
2+
3+
ARG VANILLA_VERSION=3.3
4+
ENV WEB_DOCUMENT_ROOT /vanillapp
5+
6+
# Get the latest release of Vanilla Forums
7+
RUN wget https://github.com/vanilla/vanilla/releases/download/Vanilla_${VANILLA_VERSION}/vanilla-${VANILLA_VERSION}.zip
8+
RUN unzip vanilla-${VANILLA_VERSION}.zip -d /tmp
9+
RUN cp -r /tmp/package/. /vanillapp/
10+
RUN chmod -R 777 /vanillapp
11+
12+
# Clone the forum-plugins repository
13+
RUN git clone https://github.com/topcoder-platform/forums-plugins.git /tmp/forums-plugins
14+
RUN cp -r /tmp/forums-plugins/. /vanillapp/plugins/

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#Topcoder - Forums
2+
3+
## Requirements
4+
5+
- Docker (docker deployment)
6+
7+
## Docker Deployment
8+
- Set `MYSQL_DATABASE` and `MYSQL_ROOT_PASSWORD` in api.env.
9+
These variables are mandatory. `MYSQL_ROOT_PASSWORD` specifies the password that will be set for the MySQL root superuser account.
10+
- Run `docker-compose build` to build the image
11+
- Run `docker-compose up` to run Vanilla Forums
12+
- The Vanilla Forums will be available at `http://<your_docker_machine_ip>` by default
13+
14+
## Setup Vanilla Forums
15+
16+
Go to [Setup Vanilla Forums](./docs/SetupVanillaForums.md) to complete installation.

docker-compose.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
version: '3'
2+
services:
3+
mysql-local:
4+
image: mysql
5+
container_name: mysql-local
6+
ports:
7+
- 3306:3306
8+
environment:
9+
- MYSQL_DATABASE=vanilladb
10+
- MYSQL_ROOT_PASSWORD=root
11+
command: --default-authentication-plugin=mysql_native_password
12+
vanilla-local:
13+
container_name: vanilla-local
14+
build:
15+
context: .
16+
args:
17+
- VANILLA_VERSION=3.3
18+
ports:
19+
- 80:80
20+
links:
21+
- mysql-local

docs/SetupVanillaForums.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Setup Vanilla Forums
2+
3+
# Installation
4+
The Vanilla Forums will be available at `http://<your_docker_machine_ip>` by default.
5+
6+
1.Open your browser and go to Vanilla Forums.
7+
8+
2.You should see Vanilla Forums setup wizard. Vanilla Forums Installer will
9+
create a database and an admin account. You should type the next values:
10+
- **Database Host** - `mysql-local`
11+
- **Database Name** - `vanilladb`
12+
- **Database User** - `root`
13+
- **Database Password** - `root`
14+
- **Use Vanilla's .htaccess** - selected by default.
15+
16+
Type other fields. Click on the `Continue` button to complete the installation.
17+
18+
![Vanilla Forums Wizard](./images/setup_wizard.png)
19+
20+
3.The 'Getting started' page should be displayed. You have successfully installed Vanilla Forums.
21+
22+
![Getting Started page](./images/vanilla_installed.png)
23+
24+
# Configuration
25+
26+
27+
## Enabling Addons
28+
1.Go to your `Dashboard`, then `Settings`, and select `Addons` at the bottom of the list on the left
29+
hand side panel. Navigate to the addons list and click `Enable` next to the plugin.
30+
Enabling the addon immediately makes it active and available.
31+
32+
![Vanilla Addons](./images/addons.png)
33+
34+
2.After enabling some plugins will have a `Settings` 3-strip button that appear next to them in
35+
the Addons list.
36+
37+
![Addon Settings](./images/addon_settings.png)
38+
39+
## Disabling Addons
40+
1. Disabling an addon will remove whatever features it added, but it never destroys the data associated with it.
41+
42+
43+

docs/images/addon_settings.png

186 KB
Loading

docs/images/addons.png

219 KB
Loading

docs/images/setup_wizard.png

107 KB
Loading

docs/images/vanilla_installed.png

326 KB
Loading

0 commit comments

Comments
 (0)