mirror/php-typemill
1
0
Fork 0
mirror of https://github.com/typemill/typemill.git synced 2025-08-06 06:07:31 +02:00
Code Issues Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
trendschau
2022-10-29 17:02:28 +02:00
parent a49c7f65ea
commit db8d1a5d3a
2 changed files with 52 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
composer.lock generated
View File

@@ -284,31 +284,31 @@
},
{
"name": "laminas/laminas-permissions-acl",
"version": "2.10.0",
"version": "2.12.0",
"source": {
"type": "git",
"url": "https://github.com/laminas/laminas-permissions-acl.git",
"reference": "e927ae0a3001655fea97eb240eeea9d10638e82f"
"reference": "0d88f430953fbcbce382f09090db28905b90d60f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/laminas/laminas-permissions-acl/zipball/e927ae0a3001655fea97eb240eeea9d10638e82f",
"reference": "e927ae0a3001655fea97eb240eeea9d10638e82f",
"url": "https://api.github.com/repos/laminas/laminas-permissions-acl/zipball/0d88f430953fbcbce382f09090db28905b90d60f",
"reference": "0d88f430953fbcbce382f09090db28905b90d60f",
"shasum": ""
},
"require": {
"php": "^7.4 || ~8.0.0 || ~8.1.0"
"php": "~8.0.0 || ~8.1.0 || ~8.2.0"
},
"conflict": {
"laminas/laminas-servicemanager": "<3.0",
"zendframework/zend-permissions-acl": "*"
},
"require-dev": {
"laminas/laminas-coding-standard": "~2.3.0",
"laminas/laminas-servicemanager": "^3.15.1",
"phpunit/phpunit": "^9.5.0",
"laminas/laminas-coding-standard": "~2.4.0",
"laminas/laminas-servicemanager": "^3.19",
"phpunit/phpunit": "^9.5.25",
"psalm/plugin-phpunit": "^0.17.0",
"vimeo/psalm": "^4.24.0"
"vimeo/psalm": "^4.29"
},
"suggest": {
"laminas/laminas-servicemanager": "To support Laminas\\Permissions\\Acl\\Assertion\\AssertionManager plugin manager usage"
@@ -343,7 +343,7 @@
"type": "community_bridge"
}
],
"time": "2022-07-21T09:23:39+00:00"
"time": "2022-10-17T04:26:35+00:00"
},
{
"name": "nikic/fast-route",

86
readme.md
View File

@@ -4,48 +4,41 @@ TYPEMILL is a lightweight flat file cms for micro-publishers. You can use it for
![TYPEMILL Screenshot](https://typemill.net/media/tm-demo.gif)
Note: Typemill V1 is compatible with PHP 7.4 and PHP 8.0. We are working on a version 2 now that will run with PHP 8.0 and higher.
## Features
* Website with markdown-files.
* Visual markdown editor (VUE.js) and raw markdown mode.
* Flexible drag & drop navigation.
* Markdown extras with
* table of contents (TOC)
* tables
* footnotes
* abbreviations
* definition lists
* notices
* math (with plugin)
* figures with captions
* Markdown extras with table of contents (TOC), tables, footnotes, abbreviations, definition lists, notices, figures with captions
* Media library with images and files.
* System configurations.
* User management.
* Flexible form management with YAML-files.
* Flexible access rights.
* Themes (with TWIG).
* Plugins (with symfony event dispatcher).
Some plugin highlights are:
* **Ebooks**: Generate one or many professional pdf books from your typemill website.
* **Register**: Let users register to your website and give them access to pro-content.
* **Subscribe** (in work): Sell subscriptions for premium content with traditional pdf-invoices.
* [Themes](https://themes.typemill.net) (with TWIG).
* [Plugins](https://plugins.typemill.net) (with symfony event dispatcher).
## Requirements
* PHP 7.4 or PHP 8.0 (does NOT run with PHP 8.1)
* PHP 7.4 or PHP 8.0 (Typemill V1 does NOT run with PHP 8.1)
* Apache server
* mod_rewrite and htaccess
If you run a linux system, then please double check that mod_rewrite and htaccess are active!!!
## Installation
### Bare-metal installation
### ZIP-Version
Download TYPEMILL from the [TYPEMILL website](http://typemill.net), unzip the files and you are done.
If you are a developer, you can also clone this repository. To do so, open your command line, go to your project folder (e.g. `htdocs`) and type:
The zipped version has a minimal size without developer files.
### GitHub + Composer
If you are a developer, you can clone this repository. To do so, open your command line, go to your project folder (e.g. `htdocs`) and type:
```
git clone git://github.com/typemill/typemill.git
@@ -59,9 +52,11 @@ composer update
If you did not use composer before, please go to the [composer website](http://getcomposer.org) and start to learn.
To run TYPEMILL on a **live** system, simply upload the files to your server
### Run Live
#### Make Folders Writable.
To run TYPEMILL on a **live** system, simply upload the files to your server.
### Make Folders Writable.
Make sure that the following folders and all their files are writable (permission `774` recursively):
@@ -72,26 +67,39 @@ Make sure that the following folders and all their files are writable (permissio
You can use your ftp-software for that.
### Docker installation
### Setup
If you visit your website first, then you will be redirected to the `/setup` page. Please create an initial user and configure your system in the author panel.
### Login
You can find your login screen under `/tm/login` or simply go to `/setup` and you will be redirected to the login-page, if the setup has been finished.
## Docker
> :warning: This image does not provide TLS support. It's perfect either for local use or behind your own proxy, you're advised.
Clone and edit the `config.example.php` you find in this repository and move it as `config.php`
```
git clone git://github.com/trendschau/typemill.git
cd typemill
```
Build your image locally
```
docker build -t typemill:local .
```
Run the docker image without persistence on port 8080
```
docker run -d --name typemill -p 8080:80 typemill:local
```
Run typemill with persistence
```
docker run -d \
--name=typemill \
@@ -105,7 +113,8 @@ docker run -d \
typemill:local
```
A simple `docker-compose.yml` file could looked like this
A simple `docker-compose.yml` file could look like this
```yml
version: "2.0"
@@ -123,7 +132,7 @@ services:
- 8080:80
```
#### Volumes
### Volumes
- `settings` : persists users profiles, site configuration, etc. (empty by default)
- `media` : persists media files (empty by default)
@@ -133,17 +142,15 @@ services:
- `themes` : persists installed themes (will be initialized with default examples if the binded volume is empty)
## Setup
## Kubernetes with helm chart
If you visit your website first, then you will be redirected to the `/setup` page. Please create an initial user and configure your system in the author panel.
If you are interested in Kubernetes, then you can cooperate with OLED1 and use his [helm-chart for Typemill](https://github.com/OLED1/oleds-helm-charts/tree/main/helm-development/typemill).
## Login
You can find your login screen under `/tm/login` or simply go to `/setup` and you will be redirected to the login-page, if the setup has been finished.
For questions, please open an issue in his [repository](https://github.com/OLED1/oleds-helm-charts/tree/main/helm-development/typemill).
## Documentation
You can read the full documentation for writers, for theme developers and for plugin developers on the [TYPEMILL website](http://typemill.net).
You can read the full documentation for writers, for theme developers, and for plugin developers on the [TYPEMILL website](http://typemill.net).
## Licence
@@ -151,16 +158,7 @@ TYPEMILL is published under MIT licence. Please check the licence of the include
## Contributors & Supporters
* [Severo Iuliano](https://github.com/iusvar) manages the internationalization i18n.
* [Eziquel Bruni](https://github.com/EzequielBruni) edits the typemill documentation.
* [Ricky](https://github.com/rbertram90) developed the discard functionality.
* [vodaris](https://www.vodaris.de) sponsored the development of the search plugin.
* Translations:
* Dutch: [svanlaere](https://github.com/svanlaere)
* French: [Olivier Crouzet](https://github.com/oliviercrouzet)
* German: [trendschau](https://github.com/trendschau)
* Italian: [Severo Iuliano](https://github.com/iusvar)
* Russian: [Hide-me](https://github.com/hide-me)
A lot of [contributors](https://github.com/typemill/typemill/graphs/contributors) are helping Typemill with translations, translation-logic, docker-support, kybernetes, documentation, various plugins, various themes, and a lot of fixes.
## IMPORTANT: How to Contribute
@@ -193,11 +191,11 @@ Some ideas for devs:
For hints, questions, problems and support, please open up a new issue on GitHub.
## Support
## Donate and support
This is an open source project. I love it and I spend about 20 hours a week on it (starting in 2017). There is no business model right now, but you can support this project with a donation or simply [hire me](https://trendschau.net) for implementations.
Donations are welcome: https://www.paypal.me/typemill
Donate: https://www.paypal.me/typemill
If you need professional help, please head over to [Trendschau Digital](https://trendschau.net).
## Follow