[TASK] Deprecate PageRepository->checkWorkspaceAccess
[Packages/TYPO3.CMS.git] / README.md
2 =========
4 [![Build Status](https://travis-ci.org/TYPO3/TYPO3.CMS.svg?branch=master)](https://travis-ci.org/TYPO3/TYPO3.CMS)
6 TYPO3 is an open source PHP based web content management system released
7 under the GNU GPL. TYPO3 is copyright (c) 1999-2018 by Kasper Skaarhoj.
9 This document provides a basic introduction to TYPO3.
11 Getting Started
12 ---------------
14 TYPO3 requires a webserver with PHP and a database (MySQL recommended).
15 Accessing the backend through a supported browser.
17 Please see the INSTALL.md in this folder in order to set up a basic TYPO3
18 installation on your webserver.
20 What is TYPO3?
21 --------------
23 TYPO3 is a free and open source Content Management Framework. It is released
24 under the GNU General Public License. It can run on several web servers, such
25 as Apache or IIS, on top of many operating systems, among them Linux, Microsoft
26 Windows, FreeBSD or MacOS X.
28 TYPO3 was initially authored by Kasper Skårhøj and is now further developed
29 by a community of Active Contributors around a small TYPO3 CMS Team.
31 To get more info about the GPL license, visit
32 http://www.opensource.org/licenses/gpl-license.php
34 What is a Content Management Framework?
35 ---------------------------------------
37 A Content Management Framework is more than just a content management system,
38 due to the separation of the streamlined core and optional plugins
39 (extensions). TYPO3 has an open API that allows you to extend the frontend (web
40 site) and/or backend (administration) functionalities.
42 The concept of extensions makes TYPO3 capable of being developed and used
43 in almost any way you can imagine, either by using any of the many extensions
44 which are available for download, or by writing your own.
46 TYPO3 System requirements
47 -----------------------------
49 TYPO3 is based upon PHP and uses a MySQL database. For more information
50 regarding these requirements see the [INSTALL.md](INSTALL.md) file in this folder.
52 Using the Database Abstraction Layer (DBAL) allows one to use TYPO3 with other
53 Database Management Systems, like PostgreSQL, Oracle and MSSQL.
55 TYPO3 resources
56 ---------------
58 Here is an overview of the most important TYPO3 resources to help you get
59 started:
61 ### Get more information
63 * https://typo3.org is the main project website. It provides up to
64 date official news, information about events, access to downloading the
65 products and extensions.
67 * https://wiki.typo3.org is a collaborative wiki, providing access to
68 all kind of information around the TYPO3 ecosphere.
70 * https://docs.typo3.org/: TYPO3 is one of the most thoroughly
71 documented OpenSource products around, with manuals covering basic
72 tutorials, TypoScript, administration, development, core structure, etc.
73 You should make the time to locate the various documents, and read those
74 that apply to the work you want to do.
76 ### Chat with us
78 The TYPO3 team is using a tool called Slack to openly communicate with each
79 other and with the public. Several teams use Slack as a way to communicate
80 internally and most channels are a welcome place for you to join and get
81 yourself involved.
83 * Register: https://forger.typo3.org/slack/
84 * Slack: https://typo3.slack.com/
86 ### Exchange information, ask questions, get help
88 Slack is nice for short discussions, but when asking questions, most
89 answers are lost in the noise after a few minutes. To let everyone
90 profit from an answer, we recommend to ask questions on StackOverflow.
91 If you like, you can then post a link into the corresponding Slack
92 channel to raise attention. And please, do not forget to tag your
93 questions correctly with `TYPO3` (and possibly other tags like `Fluid`
94 or `Extbase`).
96 * [StackOverflow questions tagged "TYPO3"](https://stackoverflow.com/questions/tagged/typo3)
98 The community and all TYPO3 teams communicate through newsgroups, which can
99 also be accessed through mailing lists and forums. Any of these three ways
100 provide access to the same communication channels:
102 * Forum (Web): https://forum.typo3.org/
103 * Mailing Lists (Mail): https://typo3.org/support/mailing-lists/
104 * Newsgroups (NNTP): news://lists.typo3.org/
106 Contributing
107 ------------
109 If you want to contribute to the TYPO3 CMS source code, take a look at our
110 Contributors Walkthrough and Review System:
112 * https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/
113 * https://review.typo3.org/
115 The [repository at GitHub](https://github.com/TYPO3/TYPO3.CMS) is a
116 synchronized mirror of the primary TYPO3 CMS core git repository:
118 * https://git.typo3.org/Packages/TYPO3.CMS.git
120 If you want to file a bug report, maintain your own extension using our
121 infrastructure (Git, Issue Tracker, Wiki, etc), take a look at:
123 * https://forge.typo3.org
125 Final notes
126 -----------
128 TYPO3 is said to be one of the most sophisticated PHP / Internet related
129 applications available, and the more you play with it, the more you will agree.
131 Due to the advanced level of the code and functionality, a degree of study,
132 time and perseverance is required to fully understand it, and get the best from
133 it. You should keep trying, as we say it's definitely worth it. TYPO3 is the
134 Enterprise Content Management System "for all".
136 The GPL license allows for developments that are based upon TYPO3 to also be
137 freely available under the GPL. Please remember this, because TYPO3 is about
138 "Inspiring People To Share". If you are making money with TYPO3 you can donate
139 or become a member of the TYPO3 Association.
141 By becoming a supporting member, individuals and organisations mainly fund
142 core development of TYPO3. The decision about what the funds are used for, is
143 made by all members of the Association and the Expert Advisory Board (EAB).
144 The decisions will be made transparent to the community and especially the
145 supporting members. Your funds will also serve for other purposes as laid
146 out in the bylaws.
148 * Donate: https://typo3.org/donate
149 * Become a member of the TYPO3 Association:
150 https://typo3.org/association/membership/levels/
152 Copyleft
153 --------
155 This document is a part of the TYPO3 project.
157 Written by Nigel Jackson, Ingmar Schlecht, Ernesto Baschny, Michael Stucki,
158 Oliver Hader, Ben van 't Ende and others.