From 538982e9b3078f9ffe38db43c45eaf258756d6c1 Mon Sep 17 00:00:00 2001
From: Uladzimir Tsykun <tsykun314@gmail.com>
Date: Tue, 10 Jan 2023 01:00:24 +0100
Subject: [PATCH] MdBook docs init

---
 .dockerignore        |  2 ++
 .gitignore           |  1 +
 book.toml            | 20 ++++++++++++++++++++
 docs/SUMMARY.md      |  5 +++++
 docs/installation.md | 13 +++++++++++++
 docs/readme.md       | 18 ++++++++++++++++++
 6 files changed, 59 insertions(+)
 create mode 100644 book.toml
 create mode 100644 docs/SUMMARY.md
 create mode 100644 docs/installation.md
 create mode 100644 docs/readme.md

diff --git a/.dockerignore b/.dockerignore
index 07510714..1f941e0e 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -13,3 +13,5 @@
 /docs
 /excluded
 .DS_Store
+/.github
+/book
diff --git a/.gitignore b/.gitignore
index a67f91e2..6600c2ee 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@
 /var/
 /vendor/
 ###< symfony/framework-bundle ###
+/book/
diff --git a/book.toml b/book.toml
new file mode 100644
index 00000000..63dd0187
--- /dev/null
+++ b/book.toml
@@ -0,0 +1,20 @@
+# Documentation for possible options in this file is at
+# https://rust-lang.github.io/mdBook/format/config.html
+
+[book]
+title = "Packeton Docs"
+authors = ["The Packeton.org"]
+language = "en"
+multilingual = false
+
+# The directory that documentation files are stored in
+src = "docs"
+
+[build]
+create-missing = false
+
+[output.html]
+
+edit-url-template = "https://github.com/vtsykun/packeton/edit/master/{path}"
+no-section-label = true
+git-repository-url = "https://github.com/vtsykun/packeton"
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
new file mode 100644
index 00000000..8e0274f8
--- /dev/null
+++ b/docs/SUMMARY.md
@@ -0,0 +1,5 @@
+# Summary
+
+# Introduction
+- [Overview](readme.md)
+- [Installation](installation.md)
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 00000000..055d934f
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,13 @@
+Install and Run in Docker
+------------------------
+
+You can use [packeton/packeton](https://hub.docker.com/r/packeton/packeton) image
+
+```
+docker run -d --name packeton \
+    --mount type=volume,src=packeton-data,dst=/data \
+    -p 8080:80 \
+    packeton/packeton:latest
+```
+
+etc.
diff --git a/docs/readme.md b/docs/readme.md
new file mode 100644
index 00000000..eb621061
--- /dev/null
+++ b/docs/readme.md
@@ -0,0 +1,18 @@
+# Introduction
+
+Packeton - Private PHP package repository for vendors
+
+Packeton is an open-source Composer repository homeserver for PHP private packages.
+We began development in 2018, bases on Packagist and Satis fork.
+
+## Main Features
+
+- Compatible with Composer API v2, bases on Symfony 5.4.
+- Customers user and ACL groups and limit access by vendor and versions.
+- Generic Packeton webhooks.
+- Allow to freeze updates for the new releases after expire a customers license.
+- Credentials and Authentication for privately hosted packages by oauth/http-basic config or ssh keys.
+- Support update webhook for GitHub, Bitbucket and GitLab or custom format.
+
+## Demo
+See our [Administration Demo](https://demo.packeton.org). Username/password (admin/123456)