initial commit

README.md

@@ -1,2 +1,62 @@
 # siteviewcounter
 
+[![Build Status](https://drone.deadbeef.codes/api/badges/steven/siteviewcounter/status.svg)](https://drone.deadbeef.codes/steven/siteviewcounter)
+
+A simple view counter for a website
+
+### Database initialization
+
+```sql 
+SET NAMES utf8;
+SET time_zone = '+00:00';
+SET foreign_key_checks = 0;
+
+CREATE DATABASE `counter` /*!40100 DEFAULT CHARACTER SET latin1 */;
+USE `counter`;
+
+CREATE TABLE `visit` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `ip_address` varchar(15) NOT NULL,
+  `visits` int(11) NOT NULL,
+  `last_visited` datetime NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+
+```
+
+### Example docker-compose.yml
+
+```yaml
+
+version: '3.7'
+
+services:
+ 
+  counter:
+    image: registry.deadbeef.codes/siteviewcounter:latest
+    restart: always
+    depends_on:
+      - traefik
+    expose:
+      - "8080"
+    environment:
+      - dbname=counter
+      - dbhostname=counter-db
+      - dbusername=root
+      - dbpassword=CHANGEME
+      - timezone=America/Edmonton
+      
+      
+  counter-db:
+    image: mariadb:10
+    restart: always
+    expose:
+      - "3306"
+    volumes:
+      - /data/counter-db:/var/lib/mysql
+    environment:
+      - MYSQL_RANDOM_ROOT_PASSWORD=yes
+      - MYSQL_DATABASE=counter
+      - TZ=America/Edmonton
+
+```