README.md 6.46 KB
Newer Older
1
2
3
4
TYPO3 CMS
=========

TYPO3 is an open source PHP based web content management system released
5
under the GNU GPL. TYPO3 is copyright (c) 1999-2021 by Kasper Skaarhoj.
6
7
8
9
10
11

This document provides a basic introduction to TYPO3.

Getting Started
---------------

12
TYPO3 requires a web server with PHP and a database (e.g. MySQL).
13
14
Accessing the backend through a supported browser.

15
Please see the [Installation Guide](https://docs.typo3.org/installation)
16
in order to set up a basic TYPO3 installation on your web server.
17
18
19
20

What is TYPO3?
--------------

21
22
23
24
TYPO3 is a free and open source Content Management Framework. It is
released under the GNU General Public License. It can run on several web
servers, such as Apache, nginx or IIS, on top of many operating systems,
among them Linux, Microsoft Windows, FreeBSD or MacOS.
25

26
27
28
TYPO3 was initially authored by Kasper Skårhøj and is now further
developed by a community of contributors and the [TYPO3 Core Development
Team](https://typo3.org/community/teams/typo3-development/).
29
30

To get more info about the GPL license, visit
Ben Abbott's avatar
Ben Abbott committed
31
https://opensource.org/licenses/gpl-license
32
33
34
35

What is a Content Management Framework?
---------------------------------------

36
37
38
39
A Content Management Framework is more than just a content management
system, due to the separation of the streamlined core and optional
plugins (extensions). TYPO3 has an open API that allows you to extend
the frontend (web site) and/or backend (administration) functionality.
40

41
42
43
The concept of extensions makes TYPO3 capable of being developed and
used in almost any way you can imagine, either by using any of the many
extensions which are available for download, or by writing your own.
44
45

TYPO3 System requirements
46
-------------------------
47

48
49
TYPO3 is based upon PHP and uses a database management system like
MySQL.
50

51
52
For more specific information regarding requirements see the
[INSTALL.md](INSTALL.md#server-system-requirements) file in this folder.
53
54
55
56

TYPO3 resources
---------------

57
58
Here is an overview of the most important TYPO3 resources to help you
get started:
59
60
61

### Get more information

62
* https://typo3.org is the main project website. It provides up to date
63
  official news, information about events and the TYPO3 community.
64

65
* https://docs.typo3.org/: TYPO3 is one of the most thoroughly
66
  documented OpenSource products around, with manuals covering basic
67
68
69
70
71
72
73
74
75
  tutorials, TypoScript, administration, development, core structure,
  etc. You should make the time to locate the various documents, and
  read those that apply to the work you want to do.

* https://get.typo3.org/ is the platform where you can download TYPO3
  and find all release notes and change logs of TYPO3 releases.

* https://extensions.typo3.org/ is the platform where you can search for
  and download TYPO3 extensions.
76

77
78
### Chat with us

79
80
81
82
The TYPO3 community is using a tool called Slack to openly communicate
with each other and with the public. Several TYPO3 teams use Slack as a
way to communicate internally and most channels are a welcome place for
you to join and get yourself involved.
83

84
* Register: https://my.typo3.org/about-mytypo3org/slack
85
86
* Slack: https://typo3.slack.com/

87
88
89
### Exchange information, ask questions, get help

Slack is nice for short discussions, but when asking questions, most
90
91
92
93
94
95
96
97
98
answers are lost in the noise after a few minutes.

#### StackOverflow

**To let everyone profit from an answer, we recommend to ask questions
on StackOverflow**. If you like, you can then post a link into the
corresponding Slack channel to raise attention. And please, do not
forget to tag your questions correctly with `typo3` (and possibly other
tags like `typo3-9.5.x`, `Fluid` or `Extbase`).
99
100

* [StackOverflow questions tagged "TYPO3"](https://stackoverflow.com/questions/tagged/typo3)
101

102
#### Official meet the TYPO3 Community overview:
103

104
Visit https://typo3.org/community/meet/
105

106
107
Contributing
------------
108

109
If you want to contribute to the TYPO3 source code, take a look at our
110
Contributors Walkthrough and Review System:
111

112
* https://docs.typo3.org/core-contribution
113
* https://review.typo3.org/
114

115
116
117
118
119
> Please use the [TYPO3 Slack chat](#chat-with-us), if you need help in
> setting up your contribution environment. The community is very
> helpful and get you up and running! (Please post your questions in
> Slack Channel `#typo3-cms-coredev` regarding contribution support)

120
The [repository at GitHub](https://github.com/typo3/typo3) is a
121
synchronized mirror of the primary TYPO3 core git repository:
122
123
124

* https://git.typo3.org/Packages/TYPO3.CMS.git

125
If you want to file a bug report, take a look at:
126

127
* [https://forge.typo3.org](https://forge.typo3.org/projects/typo3cms-core/issues)
128

129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
Security
--------

If you learn about a potential security issue in the TYPO3 core or in
an extension, please always contact the TYPO3 Security Team via security@typo3.org.
Please always include the version number where you've discovered the issue.
If we can confirm a problem in a third-party extension, we will inform the
author immediately.

If you discover a security problem in your own extension, please inform
the TYPO3 Security Team as well. They can help you to fix it, and they
may want to issue an advisory once it is fixed.

For more details see [TYPO3 Security Team](https://typo3.org/community/teams/security/).

144
145
146
147
Final notes
-----------

TYPO3 is said to be one of the most sophisticated PHP / Internet related
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
applications available, and the more you play with it, the more you will
agree.

Due to the advanced level of the code and functionality, a degree of
study, time and perseverance is required to fully understand it, and get
the best from it. You should keep trying, as we say it's definitely
worth it. TYPO3 is the Enterprise Content Management System "for all".

The GPL license allows for developments that are based upon TYPO3 to
also be freely available under the GPL. Please remember this, because
TYPO3 is about "Inspiring People To Share". If you are making money with
TYPO3 you can donate or become a member of the TYPO3 Association.

By becoming a supporting member, individuals and organisations mainly
fund core development of TYPO3. The decision about what the funds are
used for, is made by all members of the Association and the Expert
Advisory Board (EAB). The decisions will be made transparent to the
community and especially the supporting members. Your funds will also
serve for other purposes as laid out in the bylaws.
167

168
* Donate: https://typo3.org/donate
169
* Become a member of the TYPO3 Association:
170
  https://typo3.org/project/association/
171
172
173
174
175

Copyleft
--------

This document is a part of the TYPO3 project.