Skip to content

Commit

Permalink
MdBook docs init
Browse files Browse the repository at this point in the history
  • Loading branch information
vtsykun committed Jan 10, 2023
1 parent 6ad4e20 commit 538982e
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@
/docs
/excluded
.DS_Store
/.github
/book
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@
/var/
/vendor/
###< symfony/framework-bundle ###
/book/
20 changes: 20 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -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"
5 changes: 5 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Summary

# Introduction
- [Overview](readme.md)
- [Installation](installation.md)
13 changes: 13 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 18 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 538982e

Please sign in to comment.